diff options
| author | s-ol <s-ol@users.noreply.github.com> | 2018-10-27 14:34:08 +0000 |
|---|---|---|
| committer | s-ol <s-ol@users.noreply.github.com> | 2018-10-27 14:36:50 +0000 |
| commit | b5ff379eb327fd45ad9e46a24b5f6dad17f9017f (patch) | |
| tree | ac1da7fbf5dd18f1e3c5adcecd0746eafb68538b /README.md | |
| parent | add to webring (diff) | |
| download | mmm-b5ff379eb327fd45ad9e46a24b5f6dad17f9017f.tar.gz mmm-b5ff379eb327fd45ad9e46a24b5f6dad17f9017f.zip | |
readme etc
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
@@ -2,4 +2,29 @@ mmm === mmm is not the www, because it runs on [MoonScript][moonscript]. +live version at [mmm.s-ol.nu][mmm]. + +Building & Viewing +------------------ +mmm is built using [tup][tup]. +You can build the static content with: + + $ tup init + $ tup + +Then, run some kind of HTTP server from within `dist`, e.g. with python 3 installed: + + $ cd dist + $ python -m http.server + +You can then view the website in your browser. +The example above will provide it at `http://localhost:8000`. + +During development you may want to automatically rebuild the project as files are changed. +You can do this with the following command: + + $ tup monitor -f -a + [moonscript]: https://moonscript.org/ +[mmm]: https://mmm.s-ol.nu/ +[tup]: https://gittup.org/tup |