sw/README.md

44 lines
789 B
Markdown
Raw Normal View History

2015-01-28 22:30:07 +00:00
# sw - suckless webframework
2014-02-06 09:54:27 +00:00
sw is a minimal and sane web framework.
2015-01-28 22:30:07 +00:00
## Installation
2014-02-06 09:54:27 +00:00
Run:
2015-01-28 22:30:07 +00:00
`make && make install PREFIX=/usr/local`
## Configuration
2014-02-06 09:54:27 +00:00
Copy sw.conf and style.css to your working directory, and edit them to fit your needs.
2015-01-28 22:30:07 +00:00
## Static web generation
2014-02-06 09:54:27 +00:00
Run from your working directory:
2015-01-28 22:30:07 +00:00
`sw /path/to/site`
2014-02-06 09:54:27 +00:00
Where 'site' is the folder where your website is located.
The static version of the website is created under 'site.static'.
2015-01-28 22:30:07 +00:00
## Automatic generation+upload
2014-02-06 09:54:27 +00:00
The whole process can be automatized if you create a Makefile like this in your working directory:
2015-01-28 22:33:39 +00:00
```make
2014-02-06 09:54:27 +00:00
all:
sw /path/to/site
rsync -avz site.static/ foo.org:/path/to/wwwroot/
clean:
rm -rf site.static
2015-01-28 22:30:07 +00:00
```
## Author
2015-01-28 22:31:06 +00:00
* Nibble \<develsec.org\>
2014-02-06 09:54:27 +00:00
2015-01-28 22:30:07 +00:00
## Contributors
2014-02-06 09:54:27 +00:00
2015-01-28 22:31:06 +00:00
* pancake \<nopcode.org\>
* Andrew Antle