thomas
/
Dispensy
Volgen 1
Ster 0
Vork 0
Code Kwesties 0 Pull-aanvragen 0 Publicaties 0 Wiki Activiteit
Geen omschrijving
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.
38 Commits
1 Branch
Tree: de8aec9453
Branches Labels
${ item.name }
Maak branch ${ searchTerm }
van 'de8aec9453'
${ noResults }
Dispensy/docs
Thomas Buck de8aec9453 add links to generated docs pages 11 maanden geleden
..
modelview @ d3f2ffd2cd generate pcb 3d files and visualize in docs 11 maanden geleden
src add links to generated docs pages 11 maanden geleden
svg-pan-zoom @ 632c04b408 make svgs in docs interactive 11 maanden geleden
.gitignore generate pcb 3d files and visualize in docs 11 maanden geleden
README.md generate pcb 3d files and visualize in docs 11 maanden geleden
book.toml add license header to source files 11 maanden geleden
generate_docs.sh add links to generated docs pages 11 maanden geleden

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.