motyl

commit 3e5fea70cd3931570b7e5c501529b0a05a6f5ee1
parent a5ba847d8513a101dd75e5aea3f0468b459b5c40
Author: Frederic Cambus <fred@statdns.com>
Date:   Fri, 16 Mar 2018 10:54:20 +0100

Sync examples with current README

Diffstat:
M
examples/pages/about.md
 | 
40
++++++++++++++++++++++++----------------

1 file changed, 24 insertions(+), 16 deletions(-)
diff --git a/examples/pages/about.md b/examples/pages/about.md
@@ -1,13 +1,14 @@
 ## Description
 
-Motyl is an opinionated blog-aware static site generator written in Lua. It uses Mustache as templating system, and all content is written in Markdown.
+Motyl is an opinionated blog-aware static site generator written in Ruby.
+It uses Mustache as templating system, and all content is written in Markdown.
 
 For the record, motyl means butterfly in Polish.
 
 ## Features
 
-- Small and easy to understand code (only 130 sloc)
-- Minimal dependencies (only four Lua rocks)
+- Small and easy to understand code (only 94 sloc)
+- Minimal dependencies (only three gems)
 - Pages and posts written in Markdown
 - Templates are logic-less and use Mustache
 - Support for categories
@@ -16,30 +17,37 @@ For the record, motyl means butterfly in Polish.
 
 ## Requirements
 
-Motyl requires Lua 5.1+ and Make.
+Motyl requires Ruby and Make.
 
-### Lua modules
+### Ruby modules
 
-Motyl requires the following Lua modules:
+Motyl requires the following Ruby modules:
 
-- LuaFileSystem
-- lunamark
-- lustache
-- lyaml
+- kramdown
+- mustache
+- rouge
 
-Installing via LuaRocks:
+Installing dependencies via gem:
 
-	luarocks install luafilesystem
-	luarocks install lunamark
-	luarocks install lustache
-	luarocks install lyaml
+	gem install kramdown mustache rouge
 
 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