start work on docs

.gitignore

@@ -7,3 +7,7 @@ pcb/drumkit-backups
 pcb/plot
 pcb/fabrication
 pcb/fab.zip
+
+docs/book
+docs/src/plot
+docs/src/inc_*.md

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "pico-ssd1306"]
 	path = pico-ssd1306
 	url = https://github.com/daschr/pico-ssd1306
+[submodule "docs/svg-pan-zoom"]
+	path = docs/svg-pan-zoom
+	url = https://github.com/WebSVG/svg-pan-zoom

docs/book.toml

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: 2024 Thomas Buck <thomas@xythobuz.de>
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
+#
+#  ------------------------------------------------------------------------------
+# | Copyright (c) 2024 Thomas Buck <thomas@xythobuz.de>                          |
+# |                                                                              |
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
+# | or any later version.                                                        |
+# |                                                                              |
+# | You may redistribute and modify this source and make products using it under |
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
+# | or any later version.                                                        |
+# |                                                                              |
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
+# | for applicable conditions.                                                   |
+# |                                                                              |
+# | Source location: https://git.xythobuz.de/thomas/drumkit                      |
+# |                                                                              |
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
+# | source, You must where practicable maintain the Source Location visible      |
+# | on the external case of the Gizmo or other products you make using this      |
+# | source.                                                                      |
+#  ------------------------------------------------------------------------------
+
+[book]
+title = "LARS - Looping Automated Rhythm Station"
+authors = ["kauzerei", "xythobuz"]
+description = "Documentation for LARS, a Raspberry Pi Pico based drum machine."
+language = "en"
+multilingual = false
+src = "src"
+
+[output.html]
+default-theme = "rust"
+preferred-dark-theme = "ayu"
+git-repository-url = "https://github.com/xythobuz/lars"
+edit-url-template = "https://github.com/xythobuz/lars/edit/master/docs/{path}"
+site-url = "/lars/"

docs/generate_docs.sh

@@ -0,0 +1,77 @@
+#!/bin/bash
+
+# SPDX-FileCopyrightText: 2024 Thomas Buck <thomas@xythobuz.de>
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
+#
+#  ------------------------------------------------------------------------------
+# | Copyright (c) 2024 Thomas Buck <thomas@xythobuz.de>                          |
+# |                                                                              |
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
+# | or any later version.                                                        |
+# |                                                                              |
+# | You may redistribute and modify this source and make products using it under |
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
+# | or any later version.                                                        |
+# |                                                                              |
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
+# | for applicable conditions.                                                   |
+# |                                                                              |
+# | Source location: https://git.xythobuz.de/thomas/drumkit                      |
+# |                                                                              |
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
+# | source, You must where practicable maintain the Source Location visible      |
+# | on the external case of the Gizmo or other products you make using this      |
+# | source.                                                                      |
+#  ------------------------------------------------------------------------------
+
+INSCH="drumkit.kicad_sch"
+INPCB="drumkit.kicad_pcb"
+
+cd "$(dirname "$0")"
+
+echo "Generating plots"
+rm -rf src/plot
+../pcb/generate_plot.sh
+cp -r ../pcb/plot src
+echo
+
+for IN in $INSCH
+do
+    o="src/inc_$IN.md"
+    echo "Include for $IN at $o"
+
+    rm -rf $o
+    echo "<script src=\"js/svg-pan-zoom.js\" charset=\"UTF-8\"></script>" >> $o
+
+    for f in `ls src/plot/$IN.svg/*.svg | sort -r`; do
+        file=`echo $f | sed 's:src/:./:g'`
+        name=`echo $f | sed "s:src/plot/$IN.svg/::g" | sed 's:.svg::g'`
+        echo "Sheet at $name"
+
+        echo "<h2>$name</h2>" >> $o
+        echo "<div style=\"background-color: white; border: 1px solid black;\">" >> $o
+        echo "<embed type=\"image/svg+xml\" src=\"$file\" id=\"pz_$name\" style=\"width:100%;\"/>" >> $o
+        echo "<script>" >> $o
+        echo "document.getElementById('pz_$name').addEventListener('load', function(){" >> $o
+        echo "svgPanZoom(document.getElementById('pz_$name'), {controlIconsEnabled: true, minZoom: 1.0});" >> $o
+        echo "})" >> $o
+        echo "</script>" >> $o
+        echo "</div>" >> $o
+        echo >> $o
+        echo "[Direct link to \`$name\`]($file)." >> $o
+        echo >> $o
+    done
+
+    echo
+done
+
+echo "Generating docs"
+if [ "$1" = "serve" ] ; then
+    mdbook serve --open
+elif [ "$1" = "build" ] ; then
+    mdbook build
+else
+    echo "Invalid command. 'build' or 'serve'."
+fi

docs/src/SUMMARY.md

@@ -0,0 +1,11 @@
+# Summary
+
+# LARS
+
+- [Introduction](./introduction.md)
+
+# Hardware
+
+- [Prototype](./pcb1.md)
+  - [Schematics](./pcb1_sch.md)
+  - [PCB Layout](./pcb1_pcb.md)

docs/src/introduction.md

@@ -0,0 +1,5 @@
+# Introduction
+
+**TODO** work in progress
+
+

docs/src/js/svg-pan-zoom.js

@@ -0,0 +1 @@
+../../svg-pan-zoom/dist/svg-pan-zoom.js

docs/src/js/svg-pan-zoom.min.js

@@ -0,0 +1 @@
+../../svg-pan-zoom/dist/svg-pan-zoom.min.js

docs/src/pcb1.md

@@ -0,0 +1,4 @@
+# Prototype
+
+This is the hardware design for the initial prototype gifted as a birthday present.
+It's a single sided PCB layout suitable for hand etching at home.

docs/src/pcb1_pcb.md

@@ -0,0 +1,35 @@
+# Prototype PCB Layout
+
+This page shows the current version of the PCB layout as SVG graphics.
+
+## 2D PCB Layout
+
+You can also view the [2D PCB layout as PDF](./plot/drumkit.kicad_pcb.pdf).
+
+<script src="js/svg-pan-zoom.js" charset="UTF-8"></script>
+<div style="background-color: white; border: 1px solid black;">
+    <embed type="image/svg+xml" src="./plot/drumkit.kicad_pcb.svg" id="pz_drumkit0" style="width: 100%;"/>
+    <script>
+        document.getElementById('pz_drumkit0').addEventListener('load', function(){
+            svgPanZoom(document.getElementById('pz_drumkit0'), {controlIconsEnabled: true, minZoom: 1.0});
+        })
+    </script>
+</div>
+
+[Direct link to this file](./plot/drumkit.kicad_pcb.svg).
+
+## DIY Version
+
+You can also view the [DIY layout as PDF](./plot/drumkit.kicad_pcb_diy.pdf).
+
+<script src="js/svg-pan-zoom.js" charset="UTF-8"></script>
+<div style="background-color: white; border: 1px solid black;">
+    <embed type="image/svg+xml" src="./plot/drumkit.kicad_pcb_diy.svg" id="pz_drumkit1" style="width: 100%;"/>
+    <script>
+        document.getElementById('pz_drumkit1').addEventListener('load', function(){
+            svgPanZoom(document.getElementById('pz_drumkit1'), {controlIconsEnabled: true, minZoom: 1.0});
+        })
+    </script>
+</div>
+
+[Direct link to this file](./plot/drumkit.kicad_pcb_diy.svg).

docs/src/pcb1_sch.md

@@ -0,0 +1,7 @@
+# Prototype Schematics
+
+This page shows the current version of the schematics as SVG graphics.
+
+You can also view the [schematics as PDF](./plot/drumkit.kicad_sch.pdf).
+
+{{#include inc_drumkit.kicad_sch.md}}

docs/svg-pan-zoom

@@ -0,0 +1 @@
+Subproject commit d9b9a55ef386c6fb04a82881ee233642d61e99cf