thomas
/
Dispensy
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
No Description
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.
45 Commits
1 Branch
Tree: 4d5199f381
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4d5199f381'
${ noResults }
Dispensy/docs
Thomas Buck 4d5199f381 some words in docs about mainboard 4 months ago
..
modelview @ d3f2ffd2cd generate pcb 3d files and visualize in docs 4 months ago
src some words in docs about mainboard 4 months ago
svg-pan-zoom @ 632c04b408 make svgs in docs interactive 4 months ago
.gitignore generate pcb 3d files and visualize in docs 4 months ago
README.md generate pcb 3d files and visualize in docs 4 months ago
book.toml tweak docs 4 months ago
generate_docs.sh tweak docs 4 months ago

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.