Skip to content

Commit aa69f46

Browse files
committed
merged existing tool guides into a new Renoise Tool page
1 parent 1be1b16 commit aa69f46

File tree

16 files changed

+573
-657
lines changed

16 files changed

+573
-657
lines changed

docs/SUMMARY.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,14 @@
1010
- [Guides](guide/README.md)
1111
- [Classes](guide/classes.md)
1212
- [Observables](guide/observables.md)
13-
- [Files & Bits](guide/files&bits.md)
13+
- [Renoise Application](guide/application.md)
14+
- [Renoise Song](guide/song.md)
15+
- [Renoise Tool](guide/tool.md)
16+
- [File IO & Bits](guide/files&bits.md)
1417
- [Sockets](guide/sockets.md)
1518
- [MIDI](guide/midi.md)
1619
- [OSC](guide/osc.md)
1720
- [SQLite](guide/sqlite.md)
18-
- [Renoise Application](guide/application.md)
19-
- [Renoise Song](guide/song.md)
20-
- [Tool Keybindings](guide/keybindings.md)
21-
- [Tool Menu Entries](guide/menus.md)
22-
- [Tool Views](guide/views.md)
23-
- [Tool Preferences](guide/preferences.md)
2421
- [API Reference](API/README.md)
2522
<!-- API TOC START -->
2623
- [renoise](API/renoise.md)

docs/guide/application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Renoise Application
1+
# Renoise Application
22

33
The `renoise.app()` function is the entry point for interacting with the Renoise application itself. It returns a [`renoise.Application`](../API/renoise/renoise.Application.md) object, which provides access to global application states, functions for user interaction like dialogs, and control over the main window.
44

docs/guide/classes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The operators you can overload are:
8888
* `__eq` (equality)
8989
* `__call` (function call)
9090
* `__unm` (unary minus)
91-
* `__tostring`
91+
* `__tostring` (serialization)
9292
* `__len` (length operator `#`)
9393

9494
Note: `__tostring` isn't really an operator, but it's the metamethod that is called by the standard library's `tostring()` function.

docs/guide/files&bits.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Files & Bits
1+
# File IO & Bits
2+
3+
The Renoise API uses Lua's standard [io library](https://www.lua.org/pil/21.html) to read or write external files.
24

35
To access the raw bits and bytes of some data, for example, to read or write binary file streams, you can use the `bit` library. It's built into the Renoise API, so there's no need to `require` it.
46

5-
See the [LuaJIT bit library documentation](https://bitop.luajit.org/api.html) for more info and examples. For file operations, you can use Lua's standard [io library](https://www.lua.org/pil/21.html).
7+
See the [LuaJIT bit library documentation](https://bitop.luajit.org/api.html) for more info and examples.
68

79
```lua
810
-- Reading integer numbers or raw bytes from a file
@@ -31,7 +33,7 @@ local function read_dword(file)
3133
end
3234
end
3335

34-
-- and so on (adapt as needed to mess with endianness!) ...
36+
-- and so on (adapt as needed to deal with endianness!) ...
3537

3638
local file, err = io.open("some_binary_file.bin", "rb")
3739
if not file then

docs/guide/instruments.md

Lines changed: 0 additions & 143 deletions
This file was deleted.

docs/guide/keybindings.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/guide/menus.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/guide/pattern_iterator.md

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)