Ingen beskrivning
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
Thomas Buck da3814a868 generate separate front and back layouts for docs 9 månader sedan
..
modelview @ d3f2ffd2cd generate pcb 3d files and visualize in docs 11 månader sedan
src generate separate front and back layouts for docs 9 månader sedan
svg-pan-zoom @ d9b9a55ef3 try to fix scroll bug in docs svg viewer 10 månader sedan
.gitignore generate pcb 3d files and visualize in docs 11 månader sedan
README.md generate pcb 3d files and visualize in docs 11 månader sedan
book.toml tweak docs 11 månader sedan
generate_docs.sh generate separate front and back layouts for docs 9 månader sedan

README.md

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.