Added readme. .htaccess and config.d are also now ignored in git instead samples...
[public/www-new.git] / README.md
1 dweb - A simple website written in D
2 =====
3 dweb is a simple website framework based off the [werc][werc] software.
4
5 Its principles are:
6
7 - Database free, uses files and directories instead.
8 - Written using the D programming language.
9 - Minimize tedious work: eg., no need to ever write HTML, use markdown instead.
10 - Very minimalist yet extensible codebase. Handlers for special things should be easy to add.
11
12 It was created because werc was annoying to deploy on UW Computer Science Club's Apache setup and because [Not Invented Here](http://en.wikipedia.org/wiki/Not_Invented_Here).
13
14 [werc]:http://werc.cat-v.org/
15 [md]:http://daringfireball.net/projects/markdown
16
17 Install Guide
18 ------
19 You will need:
20 - An HTTP server with CGI support.
21 - The D compiler.
22
23 Extract the contents into the location you want to serve webpages from. Create <code>$DWEB\_ROOT/.htaccess</code> and <code>$DWEB\_ROOT/src/config.d</code> by copying the provided sample files. Then edit the following files:
24
25 - <code>$DWEB_ROOT/.htaccess</code>: make the paths work for your setup.
26 - <code>$DWEB_ROOT/src/config.d</code>: change these strings as necessary.
27 - <code>$DWEB_ROOT/src/web.d</code>: this is the main web code.
28 - <code>$DWEB_ROOT/pub/</code>: static content goes here.
29 - <code>$DWEB_ROOT/srv/</code>: directories, markdown webpages etc. go in here.
30 - <code>$DWEB_ROOT/bin/</code>: custom handlers go here.
31
32 Run <code>build</code> in <code>$DWEB_ROOT/src</code> to recompile the website software.
33
34 Source
35 --------
36
37 You can get the source code on [github](https://github.com/j3parker/dweb) or by running
38
39      git clone git://github.com/j3parker/dweb.git
40
41 Contact
42 --------
43 For questions, suggestions, bug reports and contributing patches email [j3parker](mailto:j3parker@csclub.uwaterloo.ca)
44
45 License
46 -------
47 Public domain.
48
49 Credits
50 -------
51 The idea and css stolen from [werc][werc]. This page itself also plagarised.
52
53 Thanks to John Gruber for the [Markdown.pl][md] script.