Added readme. .htaccess and config.d are also now ignored in git instead samples...
authorLuqman Aden <laden@uwaterloo.ca>
Thu, 23 Feb 2012 06:46:22 +0000 (01:46 -0500)
committerLuqman Aden <laden@uwaterloo.ca>
Thu, 23 Feb 2012 06:46:22 +0000 (01:46 -0500)
.gitignore
.htaccess [deleted file]
README.md [new file with mode: 0644]
htaccess-sample [new file with mode: 0644]
src/config.d [deleted file]
src/config.d.sample [new file with mode: 0644]

index cebac2a..7087134 100644 (file)
@@ -1,3 +1,5 @@
 pub/*
 srv/*
 bin/web
+.htaccess
+src/config.d
diff --git a/.htaccess b/.htaccess
deleted file mode 100644 (file)
index 0039b2c..0000000
--- a/.htaccess
+++ /dev/null
@@ -1,4 +0,0 @@
-RewriteEngine on
-RewriteBase /~j3parker/
-RewriteRule ^pub/(.*) - [L]
-RewriteRule ^(.*) /users/j3parker/www/bin/web [L]
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..bd0dab3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+dweb - A simple website written in D
+=====
+dweb is a simple website framework based off the [werc][werc] software.
+
+Its principles are:
+
+- Database free, uses files and directories instead.
+- Written using the D programming language.
+- Minimize tedious work: eg., no need to ever write HTML, use markdown instead.
+- Very minimalist yet extensible codebase. Handlers for special things should be easy to add.
+
+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).
+
+[werc]:http://werc.cat-v.org/
+[md]:http://daringfireball.net/projects/markdown
+
+Install Guide
+------
+You will need:
+- An HTTP server with CGI support.
+- The D compiler.
+
+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:
+
+- <code>$DWEB_ROOT/.htaccess</code>: make the paths work for your setup.
+- <code>$DWEB_ROOT/src/config.d</code>: change these strings as necessary.
+- <code>$DWEB_ROOT/src/web.d</code>: this is the main web code.
+- <code>$DWEB_ROOT/pub/</code>: static content goes here.
+- <code>$DWEB_ROOT/srv/</code>: directories, markdown webpages etc. go in here.
+- <code>$DWEB_ROOT/bin/</code>: custom handlers go here.
+
+Run <code>build</code> in <code>$DWEB_ROOT/src</code> to recompile the website software.
+
+Source
+--------
+
+You can get the source code on [github](https://github.com/j3parker/dweb) or by running
+
+     git clone git://github.com/j3parker/dweb.git
+
+Contact
+--------
+For questions, suggestions, bug reports and contributing patches email [j3parker](mailto:j3parker@csclub.uwaterloo.ca)
+
+License
+-------
+Public domain.
+
+Credits
+-------
+The idea and css stolen from [werc][werc]. This page itself also plagarised.
+
+Thanks to John Gruber for the [Markdown.pl][md] script.
diff --git a/htaccess-sample b/htaccess-sample
new file mode 100644 (file)
index 0000000..23c9137
--- /dev/null
@@ -0,0 +1,4 @@
+RewriteEngine on
+RewriteBase /
+RewriteRule ^pub/(.*) - [L]
+RewriteRule ^(.*) bin/web [L]
diff --git a/src/config.d b/src/config.d
deleted file mode 100644 (file)
index b7f1171..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-const string url_root = "/~j3parker/";
-
-const string site_title = "This is a Title";
-const string site_subtitle = "but this is a subtitle";
-
-const bool nav_tree_vert = false;
-const bool nav_tree_chev = false;
-const bool page_container = true;
-
-string[string] handlers;
-
-void init_handlers() {
-  handlers["*.md"] = "contrib/Markdown.pl";
-  handlers["changelog"] = "changelog.sh";
-}
diff --git a/src/config.d.sample b/src/config.d.sample
new file mode 100644 (file)
index 0000000..2e12188
--- /dev/null
@@ -0,0 +1,15 @@
+const string url_root = "/";
+
+const string site_title = "This is a Title";
+const string site_subtitle = "but this is a subtitle";
+
+const bool nav_tree_vert = false;
+const bool nav_tree_chev = false;
+const bool page_container = true;
+
+string[string] handlers;
+
+void init_handlers() {
+  handlers["*.md"] = "contrib/Markdown.pl";
+  handlers["changelog"] = "changelog.sh";
+}