aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authors-ol <s-ol@users.noreply.github.com>2019-10-07 15:05:00 +0000
committers-ol <s-ol@users.noreply.github.com>2019-10-07 15:14:02 +0000
commit894bde0db758f2db03fd43d9fa2cd13a33d20643 (patch)
treebb4d23e106dd24d189df9e220e72ac7e5ccb6997 /README.md
parentclean up a little (diff)
downloadmmm-894bde0db758f2db03fd43d9fa2cd13a33d20643.tar.gz
mmm-894bde0db758f2db03fd43d9fa2cd13a33d20643.zip
little meta-link updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 35cccd4..f687309 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,11 @@ You can build the static content with:
$ tup init
$ tup
-Then, run some kind of HTTP server from within `root`, e.g. with python 3 installed:
+Next you can render a sqlite3 mmmfs database using
+
+ $ moon build/render_all.moon db.sqlite3
+
+Then, run some kind of HTTP server from within `out`, e.g. with python 3 installed:
$ cd root
$ python -m http.server
@@ -37,6 +41,14 @@ You can do this with the following command:
$ tup monitor -f -a
+### Dependencies
+You will need:
+
+- [MoonScript][moonscript]: `luarocks install moonscript`
+- [lua-sqlite3](https://luarocks.org/modules/moteus/sqlite3): `luarocks install sqlite3`
+- [discount](https://luarocks.org/modules/craigb/discount): `luarocks install discount` (requires libmarkdown2)
+- [busted](https://olivinelabs.com/busted/): `luarocks install busted` (for testing only)
+
[moonscript]: https://moonscript.org/
[mmm]: https://mmm.s-ol.nu/
[tup]: https://gittup.org/tup