satelito

commit 97d4e4871c7b3df8d2ad1b43b73e2b081a93ae1f
parent c46897257208d74acc3c6514ed1ab81e1d992919
Author: Hugo Soucy <hugo@soucy.cc>
Date:   Wed, 28 Jul 2021 09:03:37 -0400

Add a usage example for the `make` command.

Diffstat:
M
README.md
 | 
9
+++++++++

1 file changed, 9 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -132,6 +132,15 @@ the basename of the file, then the current datetime.
 
 ## Usage
 
+The easiest way to build your website is with the `make` command. Go
+to the main folder, the one with your `config.lua`, and then:
+
+  `satelito make --export`.
+
+The `--export` option is to write the files in the `public_html/`
+folder, otherwise it will only display all the HTML files in the
+terminal (it's the same behaviour for the `pipe` command).
+
 Search recursively for all the markdown (or HTML) files with `find`, and piped
 directly as input to `satelito` with the `pipe` command: