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.
WARNING: adding new files
Be sure to add new files in the
doc/docs, and not in the
docs which is the folder generated by the build process.
Building the documentation
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
Testing and generating
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
docs folder at the root of the
More details on the build process:
$ make help
The docs folder at rool level contains all files that will be published. To make the current version publicly available:
- add all the new files using
git add docs
- commit using
git commit -am "message"(so new files and deleted files will be commited, except docs/CNAME file)
- and push the commit
- never delete the docs/CNAME file (which is mandatory for the final generated site to work)
- in case it has been removed, restore it using
git checkout docs/CNAME