aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: a1dd4babaa924c3767c480552ff70f5066365ea8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
mmm
===
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].  
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:

    $ cd root
    $ 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