From 39acd04b9a3da2931f7462403b1916d89d5ec775 Mon Sep 17 00:00:00 2001 From: Mikko Ahlroth Date: Mon, 3 Nov 2014 00:16:02 +0200 Subject: [PATCH] Add simple readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e082f03 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Laine + +Laine is a minimalistic, fully static blog engine which you can read all about +at [laine.nytsoi.net](http://laine.nytsoi.net/). + +## Installing for use + +1. Download the zip file from the downloads section. +2. Extract Laine to `/path/to/yourblog/`. +3. Write your posts at `/path/to/yourblog/posts/`. +4. Create index file at `/path/to/yourblog/index`. +5. Serve when hot with Nginx. + +## Installing for development + +Requirements: NPM, Bower. + +1. Clone this repo. +2. `cd /path/to/clone` +3. `npm install` +4. `bower install` +5. Write changes. +6. `gulp` to compile development version to `dev/` and minified version to + `dist/`. + +Serving locally is done easily with +`cd /path/to/clone/dev; python -m SimpleHTTPServer 8080`. You need a server +because browsers don't like AJAX requests over the `file://` scheme.