You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
README.md 946B
README.md 946B
Dispensy Documentation
You can find the documentation here on GitHub pages. This file is intended for contributors that want to modify this website!
Dependencies
The PCB SVG files are displayed using svg-pan-zoom, licensed as BSD-2-Clause.
The 3D PCB files are displayed using modelview, licensed as MIT.
Fetch the included git submodules after cloning this repository before working on the docs.
git submodule update --init
Local Build
The docs are built using mdbook, licensed as MPL-2.0.
Get the latest release from GitHub for a pre-built binary if you want to test changes to the docs locally.
./docs/generate_docs.sh serve
This will open your browser to a local development instance of the docs.