ferron

commit c0227239486d696cf9765956650a119bdfc0ff32
parent 20e9c1c23a075524b7c690db033b7fc7d16f418e
Author: Hugo Soucy <hsoucy@kronostechnologies.com>
Date:   Fri,  3 Aug 2018 17:17:02 -0400

Update the index page of the website sample.

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

1 file changed, 29 insertions(+), 33 deletions(-)
diff --git a/sites/ferron-ssg.tld/content/index.md b/sites/ferron-ssg.tld/content/index.md
@@ -1,17 +1,23 @@
-# Ferron SSG
+# Ferron
 
-Ferron is a static website generator crafted
-with [Lua >= 5.3](https://www.lua.org/).
+Ferron is a static site generator (SSG) crafted with Lua >= 5.3.
 
 *This documentation is a WIP*.
 
 ## Installation
 
-1. Make sure Lua 5.3 or up is installed on your machine.
-2. Then `git clone git@github.com:hs0ucy/ferron-ssg.git && cd
-   ferron-ssg`
-3. After that install all the dependencies above. For me, the best way
-   to do that it's via [LuaRocks](https://luarocks.org/).
+1. Make sure [Lua](https://www.lua.org/) 5.3 (or up), and
+   [Luarocks](https://luarocks.org/) are installed on your machine.
+2. Then:
+   * `git clone git@github.com:hs0ucy/Ferron.git && cd Ferron`
+   * `git submodule update --init && git submodule update --recursive --remote`
+3. The rest of the installation process is made with the Ferron CLI
+   (command-line interface) named `cornelius`.
+4. So make sure the `cornelius` file have the right permissions to be execute has a script.
+5. Otherwise: `chmod a+x cornelius`.
+6. After that `./cornelius install`. The `install` will check if Luarocks is
+   installed on your system and then install all the dependencies with it.
+7. If all went well, you are up and ready to create your site.
 
 ### Dependencies
 
@@ -20,6 +26,7 @@ with [Lua >= 5.3](https://www.lua.org/).
 * [LuaFileSysem](https://luarocks.org/modules/hisham/luafilesystem)
 * [lustache](https://luarocks.org/modules/olivine-labs/lustache)
 * [Markdown](https://luarocks.org/modules/mpeterv/markdown)
+* [mimetypes](https://luarocks.org/modules/luarocks/mimetypes)
 
 ## Get Started
 
@@ -27,7 +34,7 @@ First you need to copy the default site and give it the name of the
 website you want to create:
 
 ```
-cd sites/ && cp -R ferron-ssg.tld mynewwebsite.net && ls
+./cornelius start
 ```
 
 After that with your favorite texteditor or IDE edit the
@@ -37,40 +44,29 @@ After that with your favorite texteditor or IDE edit the
 emacs site-config.lua
 ```
 
+### Architecture of a ferron website
 
-* To simply build a web site:
-  * `lua ferron.lua`
-* To build a site in development mode:
-  * `lua ferron.lua --dev`
-
-## Architecture of `ferron-ssg` directory
-
-* `config.lua`
-* `rhino`
-* `ferron.lua`
-* **`functions`**
-  * `create-archetype-content.lua`
-  * `exec.lua`
-  * `file-utils.lua`
-  * `get-archetypes.lua`
-  * `get-sites.lua`
-  * `make-atom-feed.lua`
-  * `make-lists-of-pages.lua`
-  * `make-pages.lua`
-  * `move-to-publichtml.lua`
-  * `set-site.lua`
-  * `string-utils.lua`
-  * `table-utils.lua`
-  * `template-utils.lua`
 * **`sites`**
+    * .gitignore
     * **`ferron-ssg.tld`**
       * **`archetypes`**
+          * `.gitignore`
+          * `doc.json`
+          * `doc.md`
       * **`content`**
+          * `index.json`
+          * `index.md`
       * **`public_html`**
+          * `.gitignore`
       * `site-config.lua`
       * **`static`**
       * **`templates`**
 
+* To simply build a web site:
+  * `lua ferron.lua`
+* To build a site in development mode:
+  * `lua ferron.lua --dev`
+
 ## Content
 
 All the content of your site should be markdown (`*.md`) file and