Work on documentation

This commit is contained in:
2026-01-31 13:46:43 +01:00
parent 9b730c310e
commit 029b228025
45 changed files with 668 additions and 1318 deletions

View File

@@ -6,13 +6,15 @@ Cagire includes a built-in dictionary of all the internal Forth words. Press `Ct
The dictionary shows every available word organized by category:
- **Stack**: Manipulation words like `dup`, `swap`, `drop`
- **Arithmetic**: Math operations
- **Sound**: Sound sources and emission
- **Filter**, **Envelope**, **Effects**: Sound shaping
- **Context**: Sequencer state like `step`, `beat`, `tempo`
- **Stack**: Manipulation words like `dup`, `swap`, `drop`.
- **Arithmetic**: Math operations.
- **Sound**: Sound sources and emission.
- **Filter**, **Envelope**, **Effects**: Sound shaping.
- **Context**: Sequencer state like `step`, `beat`, `tempo`.
- And many more...
This tutorial will not teach you how to use all words. The syntax is very uniform and you can quickly learn a new word when necessary. We encourage you to explore as you play, this is the best way to learn. The tutorial will remain focused on various topics that require you to apply knowledge to a given task or specific context.
## Navigation
| Key | Action |
@@ -23,8 +25,6 @@ The dictionary shows every available word organized by category:
| `/` or `Ctrl+F` | Search |
| `Esc` | Clear search |
## Word Information
Each word entry shows:
- **Name** and aliases
@@ -32,12 +32,6 @@ Each word entry shows:
- **Description**: What the word does
- **Example**: How to use it
## Search
Press `/` to search across all words. The search matches word names, aliases, and descriptions. Press `Esc` to clear and return to browsing.
## Tips
- Use the dictionary while writing scripts to check stack effects
- Categories group related words together
- Some words have shorter aliases (e.g., `sound``s`)
Use the dictionary while writing scripts to check stack effects and study their behavior. Some words also come with shorter aliases (e.g., `sound``s`). You will learn aliases quite naturally, because aliases are usually reserved for very common words.