diff options
| author | s-ol <s-ol@users.noreply.github.com> | 2020-02-01 17:48:53 +0000 |
|---|---|---|
| committer | s-ol <s-ol@users.noreply.github.com> | 2020-02-01 17:48:53 +0000 |
| commit | 9039321733ce63d2bb404eb09709a5cab897b2a0 (patch) | |
| tree | 19281c67b1142cd8c41c91dc1ea5b6fcd701078b | |
| parent | add osc (diff) | |
| download | alive-9039321733ce63d2bb404eb09709a5cab897b2a0.tar.gz alive-9039321733ce63d2bb404eb09709a5cab897b2a0.zip | |
add README
| -rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..38d0be3 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# alive-coding + +This is an experimental livecoding langauge and environment, in which +expressions persist and update until they are removed from the source code, and +the interpreter keeps no state that you cannot manipulate directly in the +source. All this is enabled with a purely text-based language and works without +special editor support. + +## dependencies + +- [MoonScript][moonscript]: `luarocks install moonscript` +- [luafilesystem][lfs]: `luarocks install luafilesystem` +- [LPeg][lpeg]: `luarocks install lpeg` +- [osc][osc]: `luarocks install osc` +- [socket][socket]: `luarocks install luasocket` (not required in love2d) +- [posix][posix]: `luarocks install luaposix` (not required in love2d) + +## running + +headless / standalone: + + $ moon init.moon <session.alv> + +or in [LÖVE][love2d] (make sure to install the required modules for lua5.1): + + $ love . <session.alv> + +running in LÖVE adds the additional `gui` module. See [`lib/gui.moon`](lib/gui). + +[moonscript]: https://moonscript.org/ +[lfs]: https://keplerproject.github.io/luafilesystem/ +[lpeg]: http://www.inf.puc-rio.br/~roberto/lpeg/ +[osc]: https://github.com/lubyk/osc +[posix]: https://github.com/luaposix/luaposix +[socket]: http://w3.impa.br/~diego/software/luasocket/ +[love2d]: https://love2d.org/ |