From 8d4d57387dbfef025357a58f108d9920cddc5dcf Mon Sep 17 00:00:00 2001 From: Roi Martin Date: Wed, 28 Jan 2015 23:30:07 +0100 Subject: [PATCH] Improve README --- README => README.md | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) rename README => README.md (60%) diff --git a/README b/README.md similarity index 60% rename from README rename to README.md index 11c3db7..8b46483 100644 --- a/README +++ b/README.md @@ -1,40 +1,44 @@ -sw - suckless webframework -========================== +# sw - suckless webframework + sw is a minimal and sane web framework. -Installation ------------- -Run: - make && make install PREFIX=/usr/local +## Installation + +Run: + +`make && make install PREFIX=/usr/local` + +## Configuration -Configuration -------------- Copy sw.conf and style.css to your working directory, and edit them to fit your needs. -Static web generation ---------------------- +## Static web generation + Run from your working directory: - sw /path/to/site + +`sw /path/to/site` Where 'site' is the folder where your website is located. The static version of the website is created under 'site.static'. -Automatic generation+upload ---------------------------- +## Automatic generation+upload + The whole process can be automatized if you create a Makefile like this in your working directory: +``` $ cat Makefile all: sw /path/to/site rsync -avz site.static/ foo.org:/path/to/wwwroot/ clean: rm -rf site.static +``` -Author ------- -Nibble +## Author -Contributors ------------- -pancake +Nibble \ + +## Contributors + +pancake \ Andrew Antle