diff options
| author | s-ol <s-ol@users.noreply.github.com> | 2020-05-13 14:54:47 +0000 |
|---|---|---|
| committer | s-ol <s+removethis@s-ol.nu> | 2025-03-02 14:24:47 +0000 |
| commit | 1009e82b4dc2d262bce74f160a49eeb27ee66997 (patch) | |
| tree | df64d2a3aa19fb3484c15901c623d1848b83a159 /docs | |
| parent | add fltk4lua copilot UI (diff) | |
| download | alive-1009e82b4dc2d262bce74f160a49eeb27ee66997.tar.gz alive-1009e82b4dc2d262bce74f160a49eeb27ee66997.zip | |
add website to version.moon, update rockspec
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gen/layout.moon | 1 | ||||
| -rw-r--r-- | docs/guide.md | 2 | ||||
| -rw-r--r-- | docs/index.md | 2 | ||||
| -rw-r--r-- | docs/internals/extensions.md | 10 |
4 files changed, 8 insertions, 7 deletions
diff --git a/docs/gen/layout.moon b/docs/gen/layout.moon index f695963..4d43737 100644 --- a/docs/gen/layout.moon +++ b/docs/gen/layout.moon @@ -62,6 +62,7 @@ abs = (page) -> -- builtin-name; mod.name/name; mod.name link = (ref) -> return version.web if ref == '*web*' + return version.git if ref == '*git*' return version.repo if ref == '*repo*' return version.release if ref == '*release*' diff --git a/docs/guide.md b/docs/guide.md index 483f60a..94f3e27 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -59,7 +59,7 @@ be a note marking the parts of the guide where specific dependencies are required. After installing the dependencies, you can download the `alv` source code -from the [releases page][:*release*:], or clone the [git repository][:*web*:]: +from the [releases page][:*release*:], or clone the [git repository][:*repo*:]: $ git clone https://github.com/s-ol/alive.git diff --git a/docs/index.md b/docs/index.md index 7979876..1ed709a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,7 @@ system seamlessly, without resetting any part of your program (unless you want it to). `alv` is free and open source software. The code is currently being hosted -[on github][:*web*:], and is licensed under [GPLv3][license]. +[on github][:*repo*:], and is licensed under [GPLv3][license]. If you want to learn more or try out `alv` yourself, the [getting started][guide] page is a good place to start. On the other hand, if diff --git a/docs/internals/extensions.md b/docs/internals/extensions.md index bc07e58..e541d9a 100644 --- a/docs/internals/extensions.md +++ b/docs/internals/extensions.md @@ -155,7 +155,7 @@ There are four types of `Result`s that can be created: to the same value it already had. They are updated using `SigStream:set`. - `EvtStream`s transmit *momentary events*. They can transmit multiple events in a single tick. `EvtStream`s do not keep a value set on the last tick on - the next tick. They are updated using `EvtStream:add`. + the next tick. They are updated using `EvtStream:set`. - `IOStream`s are like `EvtStream`s, but their `IOStream:poll` method is polled by the event loop at the start of every tick. This gives them a chance to effectively create changes 'out of thin air' and kickstart the execution @@ -190,19 +190,19 @@ will be necessary. To implement a custom IOStream, create it as a class that inherits from the `IOStream` base and implement the constructor and `IOStream:poll`: - import IOStream from require 'alv.base' + import T, IOStream from require 'alv.base' class UnreliableStream extends IOStream - new: => super 'bang' + new: => super T.bang poll: => if math.random! < 0.1 - @add true + @set true In the constructor, you should call the super-constructor `EvtStream.new` to set the event type. Often this will be a custom event that is only used inside your extension (such as e.g. the `midi/port` type in the [midi][modules-midi] -module), but it can also be a primitive type like `'num'` in this example. In +module), but it can also be a primitive type like `T.bang` in this example. In `:poll`, your IOStream is given a chance to communicate with the external world and create any resulting events. The example stream above randomly sends bang events out, with a 10% chance each 'tick' of the system. Note that there is no |
