panelized design

Readme.md

@@ -2,15 +2,21 @@
 
 A fail-safe water flow monitoring module designed to protect CNC spindles and laser cutter tubes. It reads impulses from a ZJ-S401 water flow sensor, displays the real-time flow rate on an I2C OLED display, and triggers an active-low alarm to the CNC controller if the flow drops below a user-defined threshold.
 
-![Flow Controller Schema](images/Flow_Controller.svg)
+![Flow Controller Schema](schema.png)
 
-![Front](images/Flow_Controller_front.png)
-![Back](images/Flow_Controller_back.png)
-
-![ZJ-S401](images/Sensor_ZJ-S401.png)
+![Front](Flow_Controller_front.png)
+![Back](Flow_Controller_back.png)
 
 Designed in **KiCad v9**.
 
+## Table of Contents
+1. [Features](#features)
+2. [Hardware Design (KiCad)](#hardware-design-kicad)
+3. [Panel Design](#panel-design)
+4. [Microcontroller Pin Mapping](#microcontroller-pin-mapping)
+5. [Firmware Logic](#firmware-logic)
+6. [Development & Programming](#development--programming)
+
 ## Features
 * **Microcontroller:** WCH CH32V003J4M6 (RISC-V).
 * **Display UI:** 8-pin connector for a custom OLED/Button panel (I2C SSD1315).
@@ -24,7 +30,10 @@ Designed in **KiCad v9**.
 * **Sensor Compatibility:** ZJ-S401 (or similar 5V Hall-effect flow sensors).
 * **Output:** 3-pin CNC interface (+5V, GND, ALARM_CNC). Connects directly to standard CNC active-low sinking inputs.
 
-### Microcontroller Pin Mapping (Per Schematic)
+## Panel Design
+The `scripts` folder contains a guide to panelize the board (`Flow_Controller_Panel.kicad_pcb`) and howto generate gcode.
+
+## Microcontroller Pin Mapping (Per Schematic)
 | Pin | Schematic Net | Function |
 | :--- | :--- | :--- |
 | 1 | `FLOW_PULSE_MCU` | Input: Pulse counter from Flow Sensor (via RC Filter) |
@@ -44,3 +53,4 @@ Designed in **KiCad v9**.
 
 ## Development & Programming
 To flash the CH32V003, you will need a **WCH-LinkE** programmer connected to the 3-pin SWIO header `J1` (+5V, SWIO, GND).
+