thomas
/
Dispensy
Seguir 1
Destacar 0
Cuchillo 0
Código Incidencias 0 Peticiones pull 0 Lanzamientos 0 Wiki Actividad
Sin descripción
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 Rama
Árbol: de8aec9453
Ramas Etiquetas
${ item.name }
Crear rama ${ searchTerm }
desde 'de8aec9453'
${ noResults }
Dispensy/docs
Thomas Buck de8aec9453 add links to generated docs pages hace 11 meses
..
modelview @ d3f2ffd2cd generate pcb 3d files and visualize in docs hace 11 meses
src add links to generated docs pages hace 11 meses
svg-pan-zoom @ 632c04b408 make svgs in docs interactive hace 11 meses
.gitignore generate pcb 3d files and visualize in docs hace 11 meses
README.md generate pcb 3d files and visualize in docs hace 11 meses
book.toml add license header to source files hace 11 meses
generate_docs.sh add links to generated docs pages hace 11 meses

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.