Skip to content

docs: README *Going further* — drop stale exports count + redundant docs/ bullet #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raeq merged 1 commit into from
May 20, 2026
Merged

docs: README *Going further* — drop stale exports count + redundant docs/ bullet #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,10 @@ Full coverage of the framework, components, every export format with byte-determ

## Going further

- [`demos/`](demos/) — every demo is a complete study artifact (source + all six exports + rendered schematic).
- [`demos/`](demos/) — every demo is a complete study artifact: source plus the full set of generated exports (BOM, KiCad netlist + schematic, SPICE deck, Mermaid / Graphviz / Yosys / SVG renders, breadboard SVG, assembly guide, net / domain / interface reports). [`hello_led/docs/`](demos/hello_led/docs/) is a live example.
- [`docs/learning-path.md`](docs/learning-path.md) — suggested order for working through the demos.
- [`docs/design-principles.md`](docs/design-principles.md) — why the framework prevents what it prevents.
- [`docs/component-library-data.md`](docs/component-library-data.md) — hand-curated catalogue with datasheet links, pin maps, and footprints; [`docs/parts.md`](docs/parts.md) — auto-generated index of all 150 modelled components, searchable on the doc site.
- [`docs/`](docs/) — implementation specs for every major work package.
- [`CLAUDE.md`](CLAUDE.md) — design philosophy in full, for contributors.

## Licensing
Expand Down