generate_kicad_documentation

Repository Information

Author

Peter Polidoro

License

BSD

The files in this repository generate the documentation for kicad projects.

Setup Kicad Project for Documentation Generation

1. Clone this repository as a directory in the Kicad project repository:

git clone https://github.com/janelia-kicad/generate_kicad_documentation.git

1. Copy project.org from this repository submodule into the main Kicad project repository directory:

cp ./generate_kicad_documentation/project.org ./

1. Modify the copied version of project.org in the Kicad project repository directory to contain the specific project details.

Shell

guix time-machine -C channels.scm -- shell --pure -m manifest.scm

Generate Supplementals

Follow instrustions in generate_supplementals.org

Export BOM and README

1. Follow instructions in export_bom.org
2. Follow instructions in export_readme.org