You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+61-18Lines changed: 61 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,44 @@ npm ci
33
33
npm run dev -- --open
34
34
```
35
35
36
+
## Learn DVPE by building
37
+
38
+
The tutorials form a short path from first launch through Inspector review,
39
+
hardware mapping, export, reusable blocks, and visual customization. Each one
40
+
uses the current interface and can be completed independently.
41
+
42
+
| Tutorial | Time | You will finish with |
43
+
| --- | ---: | --- |
44
+
|[Build your first patch](docs/tutorials/GETTING_STARTED_FIRST_PATCH.md)| 10 min | A saved source-to-output graph and a clear export boundary. |
45
+
|[Inspect, map hardware, and export](docs/tutorials/INSPECTOR_HARDWARE_AND_EXPORT.md)| 15–20 min | A reviewed graph, stored Daisy target, and C++/Makefile package. |
46
+
|[Map a patch to Daisy Field](dvpe_CLD/examples/field_mapping_subtractive_tutorial.md)| 10–15 min | A working four-layer Field control map based on the included example. |
47
+
|[Create and reuse a custom block](docs/tutorials/CUSTOM_BLOCKS_AND_REUSE.md)| 15–20 min | A reusable block with chosen public ports and parameters. |
48
+
|[Choose and tune an interface design](docs/tutorials/DESIGN_MODES_AND_VISUAL_TUNING.md)| 10 min | A readable Stitch Neon or Experimentator preset. |
49
+
50
+
[Open the full tutorial index](docs/tutorials/README.md), or begin with the
51
+
first patch tutorial. The completed Field example below shows the same basic
52
+
source → processing → output flow used throughout the series.
53
+
54
+

55
+
56
+
## Inspect, target, and export
57
+
58
+
The normal handoff is **Inspector → Hardware → Export C++**. **Advanced** is an
59
+
optional external-AI review pass, not a replacement for compilation or hardware
60
+
validation. Follow the complete
61
+
[Inspector, Hardware, and Export tutorial](docs/tutorials/INSPECTOR_HARDWARE_AND_EXPORT.md)
62
+
for the step-by-step workflow.
63
+
64
+
| Inspector | Hardware |
65
+
| --- | --- |
66
+
| Edit the selected block's identity and parameters, enable CV inputs, and trace every accepted connection. | Select Daisy Seed, Pod, or Field; then review pin, peripheral, and Field-surface mappings stored with the project. |
67
+
|||
68
+
69
+
| Export C++ | Advanced |
70
+
| --- | --- |
71
+
| Review the target header and generated callback before downloading the C++ source and Makefile ZIP. | In Experimentator, configure provider, model, and browser-only API key under **Inspector → Design → AI Export Settings**, then compare the raw and corrected previews. |
72
+
|||
73
+
36
74
## What works now
37
75
38
76
- A catalog of 174 runtime blocks in 9 categories, with 329 parameters and
@@ -45,7 +83,7 @@ npm run dev -- --open
45
83
modules, and port binding.
46
84
-`.dvpe` save/load, autosave recovery, recent projects, and embedded custom
47
85
block definitions.
48
-
- Daisy-oriented C++, headers, and Makefile generation, downloaded as a ZIP.
86
+
- Daisy-oriented C++ source and Makefile generation, downloaded as a ZIP.
49
87
- Hardware/Field mapping, conflict checks, polyphonic code paths, and an
50
88
optional Advanced Export pass using a user-supplied AI API key.
51
89
@@ -65,7 +103,8 @@ between them with the design button in the top bar.
65
103
66
104
Stitch Neon and Experimentator are fine-tunable in **Inspector → Design**.
67
105
Changes are applied live, and both modes support saved presets. See the
68
-
[complete Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md)
106
+
[design tuning tutorial](docs/tutorials/DESIGN_MODES_AND_VISUAL_TUNING.md) or
107
+
the [complete Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md)
69
108
for the full workflow, controls, shortcuts, export steps, and troubleshooting.
70
109
71
110
## Current state
@@ -91,18 +130,20 @@ custom blocks and nested internals. May added Field hardware mapping,
91
130
polyphonic generation, persistence, Neon design work, and a compact polyphonic
92
131
Grainlet workflow. July added reproducible dependency locking, tracked codegen
93
132
fixtures, and CI coverage. In September 2026 the public product description,
94
-
block catalog, GUI documentation, dependency lock, lint contract, and Windows
95
-
startup path were reconciled against the running application.
133
+
block catalog, guided tutorials, GUI documentation, locked startup path, and
134
+
export-to-hardware handoff were reconciled against the running application.
96
135
97
-
## Tutorials and documentation
136
+
## Documentation
98
137
99
-
| Start here | What it covers |
100
-
| --- | --- |
101
-
|[Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md)| Complete GUI workflow: add, connect, edit, design, map hardware, save, and export. |
102
-
|[Daisy Field Mapping tutorial](dvpe_CLD/examples/field_mapping_subtractive_tutorial.md)| A guided subtractive-synth patch with knobs, keys, shift layers, conflicts, and C++ export. |
103
-
|[Glassmorphism design tutorial](dvpe_DESIGN/dvpe_glassmorphism_ai_guide.md)| A visual design study for tuning transparent blocks, wire glow, and readable UI chrome. |
104
-
|[Block catalog reference](docs/reference/DVPE_Diagram_Block_Reference.md)| The generated 174-block inventory, categories, parameters, ports, and intended uses. |
105
-
|[User guide index](docs/user-guide/README.md)| A compact entry point to all end-user documentation. |
138
+
-[Tutorial index](docs/tutorials/README.md)
139
+
-[Build your first patch](docs/tutorials/GETTING_STARTED_FIRST_PATCH.md)
140
+
-[Inspect, map hardware, and export](docs/tutorials/INSPECTOR_HARDWARE_AND_EXPORT.md)
141
+
-[Create and reuse custom blocks](docs/tutorials/CUSTOM_BLOCKS_AND_REUSE.md)
142
+
-[Tune the three interface designs](docs/tutorials/DESIGN_MODES_AND_VISUAL_TUNING.md)
143
+
-[User guide index](docs/user-guide/README.md)
144
+
-[Block Diagram and Inspector guide](docs/user-guide/BLOCK_DIAGRAM_AND_INSPECTOR_GUIDE.md)
0 commit comments