doku

README.md

@@ -1,3 +1,11 @@
-Das Lötprojekt Schneemann
+Das Lötprojekt Nichträuchermännchen
+===================================
  
-zusammen mit Auf weiter Flur e.V.
+Entstanden in Zusammenarbeit mit Auf weiter Flur e.V. und Chaoschemnitz e.V.
+
+Bei dem Nichträuchermännchen handelt es sich, in Anlehnung an erzgebirgische Traditionen, um ein Holzmännchen. Aber nicht um ein Räuchermännchen, sondern um eines, das mit einem Sensor die Luftqualität misst und als LED-Anzeige ausgibt. Daher Nichträuchermännchen.
+
+In main.py findet Ihr das Programm, das auf einem Raspberry Pico laufen soll und die Steuerung übernimmt.
+Dazu benötig man noch einige Jumperkabel, einen Sensor JPXXX sowie einen Streifen WS2812b-LEDs (aka Neopixel).
+
+Der Schaltplan, wie er zu diesem Code passt ist in der Entsprechenden fritzing-Datei/PDF-Export im dok-Verzeichnis.