ferron

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

commit ebef50c5bae30b8a2dd165b862a2bf433e9c944a
parent 436a383050fd3ee19c215e666744944f0cd06c76
Author: Hugo Soucy <hsoucy@kronostechnologies.com>
Date:   Tue, 24 Jul 2018 10:49:01 -0400

Update the README and the `cornelius` welcome message.

Diffstat:
MREADME.md | 3++-
Mcornelius | 9+++++++++
2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md @@ -9,7 +9,8 @@ Ferron is a static site generator (SSG) crafted with Lua >= 5.3. 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` -3. The rest of the installation process is made with the Ferron CLI: `cornelius`. +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 diff --git a/cornelius b/cornelius @@ -30,4 +30,13 @@ elseif arg[1] == "create" then else print("Hi, I'm Cornelius Ferron, the eminence of the great horn of the static site generator... or if you prefer, the CLI.") print("What Can I Do for You?") + print([[ +Your options are: + * `install` - Install ferron and his dependencies + * `build [--dev]` - Build your site in prod or dev + * `create` - Create content from archetypes + +Usage: + * `./cornelius commandname [options]` +]]) end