Author: Frederic Cambus <firstname.lastname@example.org>
Date: Fri, 16 Mar 2018 10:54:20 +0100
Sync examples with current README
1 file changed, 24 insertions(+), 16 deletions(-)
diff --git a/examples/pages/about.md b/examples/pages/about.md
@@ -1,13 +1,14 @@
-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.
-- 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.
-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:
-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.
+The 'examples' directory contains a sample site which can be used as a
+### Installing a theme
+Clone the [Chrysalide](https://github.com/fcambus/chrysalide) theme repository
+and place the files in the `themes` directory.
+Simply run `make` to build the site, it will generate posts and pages into
+the `public` directory, and will also copy static assets.
Motyl is released under the BSD 2-Clause license. See `LICENSE` file