ferron

commit 4c386d97c73ac1469f3333f442aa13b2b35058f9
parent cac116513ebdb97c2942490cf469972e06a199eb
Author: Hugo Soucy <hugo@soucy.cc>
Date:   Mon, 20 Nov 2017 22:01:24 -0500

Continue the ferron documentation

Diffstat:
M
sites/ferron-ssg.tld/content/index.md
 | 
32
+++++++++++++++-----------------

1 file changed, 15 insertions(+), 17 deletions(-)
diff --git a/sites/ferron-ssg.tld/content/index.md b/sites/ferron-ssg.tld/content/index.md
@@ -9,8 +9,8 @@ with [Lua >= 5.3](https://www.lua.org/).
 
 1. Make sure Lua 5.3 or up is installed on your machine.
 2. `git clone git@github.com:hs0ucy/ferron-ssg.git && cd ferron-ssg`
-3. Install all the dependencies above. And for me the best to do that
-   it's via [LuaRocks](https://luarocks.org/).
+3. Install all the dependencies above, and for me the best way to do
+   that it's via [LuaRocks](https://luarocks.org/).
 
 ### Dependencies
 
@@ -41,21 +41,19 @@ with [Lua >= 5.3](https://www.lua.org/).
   * template-utils.lua
 * **`sites`**
     * **`ferron-ssg.tld`**
-        * **`archetypes`**
-        * **`content`**
-        * **`public_html`**
-        * `site.config.lua`
-        * **`static`**
-        * **`templates`**
+      * **`archetypes`**
+      * **`content`**
+      * **`public_html`**
+      * `site.config.lua`
+      * **`static`**
+      * **`templates`**
 
 ## Usage
 
-* To simply build the web site:
-    * `./fakestache`
-* To build the site in development mode:
-    * `./fakestache -d`
-* You can force the complete reset of the web site before building it:
-    * `./fakestache -r`
+* To simply build a web site:
+    * `lua ferron.lua`
+* To build a site in development mode:
+    * `lua ferron.lua --dev`
 
 ## Content
 
@@ -75,12 +73,12 @@ tree.
 1. The first argument is the name (whithout the `*.md` extension) of an existing archetype.
 2. The second (and the last) argument is the title you want to give to your content.
 
-* `./fakestache nameofthearchetype "The title you want for your content"`
+* `lua ferron.lua nameofthearchetype "The title you want for your content"`
 
 So if i'm using the `sample.md` archetype to create a new content it
 will look like this :
 
-* `./fakestache sample "This is my first content made from an archetype"`
+* `lua ferron.lua sample "This is my first content made from an archetype"`
 
 If it is a success Ferron will output something like this :
 
@@ -93,7 +91,7 @@ away whithout the need of filling the metadatas.
 
 Ferron uses
 the [mustache template engine](http://mustache.github.io/)
-([for bash](https://github.com/tests-always-included/mo)) to give more
+([for lua](https://github.com/tests-always-included/mo)) to give more
 flexibility to build your theme. When you build your project
 Ferron converts mustache templates to pandoc HTML templates.