aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authors-ol <s-ol@users.noreply.github.com>2018-11-26 05:31:08 +0000
committers-ol <s-ol@users.noreply.github.com>2018-11-26 05:31:08 +0000
commitb4b3c3765a10ee6ef5ac1c3106c3414fe11072f6 (patch)
tree8234059e21f3ab06ca5ad0955fcfbba7e1499f94
parentrename youtube type to youtube/video (diff)
downloadmmm-b4b3c3765a10ee6ef5ac1c3106c3414fe11072f6.tar.gz
mmm-b4b3c3765a10ee6ef5ac1c3106c3414fe11072f6.zip
update readme
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index abd704c..a1dd4ba 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,18 @@ mmm is not the www, because it runs on [MoonScript][moonscript].
live version at [mmm.s-ol.nu][mmm].
+What?
+-----
+This repo is roughly split into three parts:
+
+- `mmm.dom`, `mmm.component`: polymorphic Lua/Moonscript modules web development.
+ \[[code: `mmm`](mmm) - [docs](https://mmm.s-ol.nu/meta)\]
+- `mmmfs`: the CMS/FS powering [mmm.s-ol.nu](https://mmm.s-ol.nu).
+ \[[code: `mmm/mmmfs`](mmm/mmmfs) - [article](https://mmm.s-ol.nu/articles/mmmfs)\]
+- the page contents: includes my portfolio, blog, experiments...
+ authored using a mix of Moonscript, Markdown and HTML, thanks to the power of `mmmfs`.
+ \[[data: `root`](root), but you might want to read a bit about mmmfs before you jump in.
+
Building & Viewing
------------------
mmm is built using [tup][tup].
@@ -12,9 +24,9 @@ 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:
+Then, run some kind of HTTP server from within `root`, e.g. with python 3 installed:
- $ cd dist
+ $ cd root
$ python -m http.server
You can then view the website in your browser.