supersonic
/
sw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve README

This commit is contained in:
Roi Martin 2015-01-28 23:30:07 +01:00
parent 54734363c8
commit 8d4d57387d
1 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README → README.md
View File

@ -1,40 +1,44 @@
sw - suckless webframework # sw - suckless webframework
==========================
sw is a minimal and sane web framework. sw is a minimal and sane web framework.
Installation ## Installation
------------
Run: Run:
make && make install PREFIX=/usr/local
`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. 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: Run from your working directory:
sw /path/to/site
`sw /path/to/site`
Where 'site' is the folder where your website is located. Where 'site' is the folder where your website is located.
The static version of the website is created under 'site.static'. 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: The whole process can be automatized if you create a Makefile like this in your working directory:
```
$ cat Makefile $ cat Makefile
all: all:
sw /path/to/site sw /path/to/site
rsync -avz site.static/ foo.org:/path/to/wwwroot/ rsync -avz site.static/ foo.org:/path/to/wwwroot/
clean: clean:
rm -rf site.static rm -rf site.static
```
Author ## Author
------
Nibble <develsec.org>
Contributors Nibble \<develsec.org\>
------------
pancake <nopcode.org> ## Contributors
pancake \<nopcode.org\>
Andrew Antle Andrew Antle