motyl

Opinionated blog-aware static site generator written in Ruby
Log | Files | Refs | README | LICENSE

commit 1004efaac967d617cae85d867cc14e795e8d41ea
parent 1dd876d9b13ff3480a1b48fc936a025ebd89eb4f
Author: Frederic Cambus <fred@statdns.com>
Date:   Mon,  7 Aug 2017 20:08:04 +0200

Add some configuration and usage information in README

Diffstat:
MREADME.md | 15+++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md @@ -7,7 +7,7 @@ For the record, motyl means butterfly in Polish. ## Features -- Small and easy to understand code (only 130 sloc) +- Small and easy to understand code (only 131 sloc) - Minimal dependencies (only four Lua rocks) - Pages and posts written in Markdown - Templates are logic-less and use Mustache @@ -37,10 +37,21 @@ Installing dependencies via LuaRocks: Alternatively, those modules can be installed directly using binary packages. -## Installation +## Configuration + +The 'examples' directory contains a sample site which can be used as a +starting point. + +### Installing a theme + +Clone the [Chrysalide](https://github.com/fcambus/chrysalide) theme repository +and place the files in the `themes` directory. ## Usage +Simply run `make` to build the site, it will generate posts and pages into +the `public` directory, and will also copy static assets. + ## License Motyl is released under the BSD 2-Clause license. See `LICENSE` file