This repository contains the source code and the documentation of the DSP libraries of the Faust Programming Language.
Here is the online documentation of the Faust libraries (which also serves as a proper README for this repository).
- you must have awk and mkdocs installed.
- you must have the Faust source code installed. You can get it from github.
Be sure to add new files in the doc/docs, and not in the docs which is the folder generated by the build process.
The build process is based on make located in the doc folder. Building the documentation site is based on mkdocs.
To install the required components type:
To generate all these files type:
$ make install
You can test the web site using the mkdoc embedded web server. This server also scan any change in the source directory and refresh the pages dynamically which is really convenient for the development process. To launch the server type:
$ make serve
When ready, you can generate the documentation web site. Type:
$ make build
The web site will be available from the site folder at the root of the faustlibraries folder
More details on the build process:
$ make help
Publishing is handled by GitHub Actions. Pushing to the main branch will build and deploy the site.
The site exposes an llms.txt file generated from doc/docs/llms.txt and published at https://faustlibraries.grame.fr/llms.txt.
- never delete the doc/docs/CNAME file (which is mandatory for the final generated site to work)
