diff options
| author | s-ol <s-ol@users.noreply.github.com> | 2020-03-16 10:30:03 +0000 |
|---|---|---|
| committer | s-ol <s-ol@users.noreply.github.com> | 2020-03-16 10:32:55 +0000 |
| commit | 572342d7c115e029018d980c0c51f87bfe762283 (patch) | |
| tree | 3646dceae0daf668d5ab50f586b0ccca55dd08f5 | |
| parent | doc styling, preparation for internal md documentation (diff) | |
| download | alive-572342d7c115e029018d980c0c51f87bfe762283.tar.gz alive-572342d7c115e029018d980c0c51f87bfe762283.zip | |
update README
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | README.md | 36 |
2 files changed, 33 insertions, 7 deletions
@@ -5,8 +5,8 @@ DEPS=core/version.moon extra/docs.moon extra/layout.moon extra/dom.moon .PHONY: docs reference internals release clean docs: docs/index.html docs/guide.html reference internals - reference: $(MODREFS) docs/reference/index.html +internals: docs/internals/index.html release: rm -f core/version.moon @@ -30,7 +30,7 @@ docs/ldoc.css: docs/style.css docs/ldoc.ltp: $(DEPS) moon extra/docs.moon $@ ldoc -internals: core/config.ld docs/ldoc.ltp docs/ldoc.css +docs/internals/index.html: core/config.ld docs/ldoc.ltp docs/ldoc.css ldoc core clean: @@ -6,6 +6,9 @@ the interpreter keeps no state that you cannot manipulate directly in the source. This yields a direct-manipulation like experience with a purely text-based language and works without special editor support. +This README contains a short overview over installation and development +processes. For more information, visit the full [online documentation][docs]. + ## dependencies - [MoonScript][moonscript]: `luarocks install moonscript` @@ -14,20 +17,39 @@ text-based language and works without special editor support. - [osc][osc]: `luarocks install osc` - [socket][socket]: `luarocks install luasocket` - [system][system]: `luarocks install luasystem` -- [lua-rtmidi][rtmidi]: `luarocks install https://raw.githubusercontent.com/s-ol/lua-rtmidi/master/lua-rtmidi-dev-1.rockspec` +- [lua-rtmidi][rtmidi]: `luarocks install + https://raw.githubusercontent.com/s-ol/lua-rtmidi/master/lua-rtmidi-dev-1.rockspec` - [busted][busted]: `luarocks install busted` (optional, for tests) - [discount][discount]: `luarocks install discount` (optional, for docs) -- [ldoc][ldoc]: `luarocks install ldoc` (optional, for docs) +- [ldoc][ldoc]: `luarocks install + https://raw.githubusercontent.com/s-ol/LDoc/moonscript/ldoc-scm-2.rockspec` + (optional, for docs) -\* these are also `moonscript` dependencies and do not neet to be installed manually. +\* these are also `moonscript` dependencies and do not neet to be installed +manually. ## docs -with `make` the HTML documentation is generated in `docs/`. +With `make` the HTML documentation is generated in `docs/`. +The latest documentation is publicly available online at [alive.s-ol.nu][docs]. -## running +## starting the copilot $ moon init.moon <session.alv> + +For more information see the [getting started guide][guide]. + +## running the tests + +The tests use the [busted][busted] Lua unit testing framework. To run all +tests, simply start busted in the main directory: + + $ busted + +To run individual test files, for example to speed up execution during +development, simply pass the files as arguments: + + $ busted spec/core/value_spec.moon [moonscript]: https://moonscript.org/ [lfs]: https://keplerproject.github.io/luafilesystem/ @@ -38,3 +60,7 @@ with `make` the HTML documentation is generated in `docs/`. [rtmidi]: https://github.com/s-ol/lua-rtmidi/ [busted]: https://olivinelabs.com/busted/ [discount]: https://luarocks.org/modules/craigb/discount +[ldoc]: https://github.com/s-ol/LDoc + +[docs]: https://alive.s-ol.nu +[guide]: https://alive.s-ol.nu/guide.html |