Thomas Buck 57aca6a04d use new 3d rendering in docs | 6 months ago | |
---|---|---|
.. | ||
src | 6 months ago | |
svg-pan-zoom @ d9b9a55ef3 | 8 months ago | |
.gitignore | 9 months ago | |
README.md | 9 months ago | |
book.toml | 9 months ago | |
generate_docs.sh | 6 months ago |
You can find the documentation here on GitHub pages. This file is intended for contributors that want to modify this website!
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
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.