ferron

Ferron is a fast and simple static website generator made with Lua.
Log | Files | Refs | Submodules | README | LICENSE

commit 4420ef88db1a98dde7c001d83f48ea679e2f467e
parent c0227239486d696cf9765956650a119bdfc0ff32
Author: Hugo Soucy <hsoucy@kronostechnologies.com>
Date:   Fri,  3 Aug 2018 17:27:09 -0400

Update the README

Diffstat:
MREADME.md | 27++++++++-------------------
1 file changed, 8 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md @@ -31,20 +31,17 @@ Ferron is a static site generator (SSG) crafted with Lua >= 5.3. ## Get Started First you need to copy the default site and give it the name of the -website you want to create: +website you want to create... to do so just type this and follow the +instructions: -``` -./cornelius start -``` +* `./cornelius start` After that with your favorite texteditor or IDE edit the `site-config.lua` to meet the needs of your web site: -``` -emacs site-config.lua -``` +* `emacs site-config.lua` -### Architecture of a ferron website +### Architecture of a Ferron website * **`sites`** * .gitignore @@ -63,9 +60,9 @@ emacs site-config.lua * **`templates`** * To simply build a web site: - * `lua ferron.lua` + * `./cornelius build` * To build a site in development mode: - * `lua ferron.lua --dev` + * `./cornelius build --dev` ## Content @@ -82,15 +79,7 @@ tree. ### Create a content from an archetype -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. - -* `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 : - -* `lua ferron.lua sample "This is my first content made from an archetype"` +* `./cornelius create` If it is a success Ferron will output something like this :