Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 1.49 KB

File metadata and controls

23 lines (18 loc) · 1.49 KB

Documentation (English index)

The in-depth documentation of ComponentHub is currently available in French only. Translations are welcome - see CONTRIBUTING.md.

Until then, here are the existing guides (in French, under docs/fr/):

Document What it covers
Getting started Clone the repo, install the tools, build and run - step by step, on Windows, Linux and Raspberry Pi. Written for absolute beginners.
User manual How to use the application day to day (inventory, stock, locations, projects, backups).
Build reference Multi-platform build details (native and cross-compilation).
Architecture The layered design (domain / storage / UI) and how to read the code.
LAN supervision & updates The shared "morf" modules: LAN presence/metrics (morfBeacon) and GitHub update check (morfUpdate).
ADR-0001 Why the desktop app is the master and the ESP32 became a satellite.

The root-level documents are already in English: README · CHANGELOG · ROADMAP · CONTRIBUTING.

Want to help translate a page? Copy docs/fr/<file>.md to docs/en/<file>.md, translate it, and update the link above. Please keep the French version in sync when you change behavior.