cml/caw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

examples.md : Experiment with decorating markdown with code type and diagrams

Browse Source
This commit is contained in:
kevin 2024-09-10 10:31:19 -04:00
parent 9f136e704d
commit 8624bad757
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
examples/examples.md
View File

@ -1,5 +1,16 @@
:::mermaid
graph LR
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
subgraph work
C -->|One| D[Laptop]
C --x|Two| E[iPhone]
C -.->|Three| F[fa:fa-car Car]
C ==> G((Bike))
C --> J>TV]
end
:::
### Example 01 - Write a sine signal to an audio file. ### Example 01 - Write a sine signal to an audio file.
@ -9,7 +20,7 @@ In this example the program is contained in the dictionary labeled `sine_file_01
the preceeding fields (e.g. `base_dir`,`proc_dict`,`subnet_dict`, etc.) contain the preceeding fields (e.g. `base_dir`,`proc_dict`,`subnet_dict`, etc.) contain
system parameters that the program needs to compile and run the program. system parameters that the program needs to compile and run the program.
``` ```YAML
{ {
base_dir: "~/src/caw/examples", base_dir: "~/src/caw/examples",
proc_dict: "~/src/caw/examples/proc_dict.cfg", proc_dict: "~/src/caw/examples/proc_dict.cfg",
@ -32,6 +43,9 @@ system parameters that the program needs to compile and run the program.
} }
} }
``` ```
When executed this program will write a five second sine signal to an audio file When executed this program will write a five second sine signal to an audio file
@ -72,7 +86,7 @@ processor class file named by the `proc_dict` system parameter field.
Here are the class specifications for `sine_tone` and `audio_file_out`. Here are the class specifications for `sine_tone` and `audio_file_out`.
``` ```yaml
sine_tone: { sine_tone: {
vars: { vars: {
srate: { type:srate, value:0, doc:"Sine tone sample rate. 0=Use default system sample rate"} srate: { type:srate, value:0, doc:"Sine tone sample rate. 0=Use default system sample rate"}