A documentation generator for open hardware projects.
- Generate beautiful documentation for open hardware projects from source files stored on GitHub!
- python 3.6 or higher (package python3);
Install all the required tools in a virtualenv:
$ make install
To run the application locally:
$ make serve
To test if project.json is a valid JSON file:
$ make test-json
If you'd like to contribute, please raise an issue or fork the repository and use a feature branch. Pull requests are warmly welcome.
The code in this project is licensed under MIT license. See the LICENSE file for details.
- Julien Lebunetel - jlebunetel