Skip to content

Commit d23fa54

Browse files
committed
fix: gendoc transition to using Buffer was not complete
1 parent 32784f8 commit d23fa54

6 files changed

Lines changed: 112 additions & 393 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,16 @@ We're not far from completing [miletone 0.1.0](https://github.com/buzz-language/
3737
- zig master
3838

3939
### Steps
40-
From cloned buzz repository:
41-
- `zig build -Drelease-safe`
42-
- `zig-out/bin/buzz <myscript.buzz>`
40+
1. Clone project: `git clone https://github.com/buzz-language/buzz <buzz_dir>`
41+
2. Build it: `zig build -Drelease-safe`
42+
3. Add to your shell rc:
43+
```bash
44+
export BUZZ_PATH="/path/to/buzz"
45+
export PATH="$BUZZ_PATH/zig-out/bin:$PATH"
46+
```
47+
4. Have fun: `buzz <myscript.buzz>`
48+
49+
Additionnally, install the [VS Code extension](https://github.com/buzz-language/code) to get syntax highlighting. If you don't use VS Code but your editor supports [TextMate grammar files](https://github.com/buzz-language/code/blob/main/syntaxes/buzz.tmLanguage.json), you can use that.
4350

4451
## Quick tour
4552

doc/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,6 @@ Remove element form the list shifting elements after index
101101
### `fun len() > num`
102102
**Returns:** Length of list
103103

104-
### `fun next(num key) > num?`
105-
Given index, returns next index or null if end of list is reached (function used by `foreach`).
106-
- **`key`**: current index
107-
108-
**Returns:** Next index
109-
110104
### `fun sub(num start, num? len) > [T]`
111105
Get sub list
112106
- **`start`**: Start index of sub list

0 commit comments

Comments
 (0)