Updated formatting of CMless README for use with `discount`.

[cmless] / README.md

diff --git a/README.md b/README.md
index 088090a..1b014db 100644 (file)
--- a/README.md
+++ b/README.md
@@ -12,8 +12,72 @@ Status
 
 CMless is not yet functional. The stages required to reach basic functionality are:
 
 
 CMless is not yet functional. The stages required to reach basic functionality are:
 

-1. Figure out deployment scheme
-2. Interpret URL and locate/serve appropriate page
-3. Feed pages through a document processor
-4. Feed pages through a template engine
-5. Generate menu based on directory structure
+1. ~~Figure out deployment scheme~~
+2. ~~Interpret URL and locate/serve appropriate page~~
+3. ~~Feed pages through a document processor~~
+4. ~~Feed pages through a template engine~~
+5. ~~Generate menu based on directory structure~~
+6. Write documentation, including a sample site.
+
+Installation Example - Debian Linux
+-----------------------------------
+
+Enable CGI scripts:
+
+    a2enmod cgi
+
+Create and enable an Apache vhost.
+
+    vi /etc/apache2/sites-available/cmless.subgeniuskitty.com
+
+    <VirtualHost *:80>
+            DocumentRoot "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com"
+            ServerName cmless.subgeniuskitty.com
+            ServerAdmin webmaster@subgeniuskitty.com
+            ErrorLog /var/log/apache2/error_log.cmless.subgeniuskitty.com
+            CustomLog /var/log/apache2/access_log.cmless.subgeniuskitty.com combined
+            AddHandler cgi-script .py
+            <Directory "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com">
+                    Options -ExecCGI -Indexes
+                    AllowOverride None
+                    Order allow,deny
+                    Allow from all
+            </Directory>
+            <Directory "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin">
+                    Options ExecCGI
+                    AllowOverride None
+                    Order allow,deny
+                    Allow from all
+            </Directory>
+            RewriteEngine On
+            RewriteRule (.*) /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/site/$1
+            RewriteCond %{REQUEST_FILENAME} !-f
+            RewriteRule .* /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin/cmless.py
+    </VirtualHost>
+
+    a2ensite cmless.subgeniuskitty.com
+    service apache2 reload
+
+Clone the CMless git repository into the Apache vhost directory.
+
+    cd /mnt/data/apache_vhosts
+    git clone https://github.com/subgeniuskitty/cmless.git cmless.subgeniuskitty.com
+    chown -R www-data:www-data ./cmless.subgeniuskitty.com
+
+Clone your content into the `site/` folder. If you with to use a different
+folder, edit the configuration options in `bin/config.py` accordingly. If this
+is your first CMless site, see the `site_sample/` folder for an example site
+using Markdown.
+
+    cd /mnt/data/apache_vhosts/cmless.subgeniuskitty.com
+    git clone your_site_content_repo site
+    chown -R www-data:www-data ./site
+
+Install an appropriate document processor for your content and set the
+`markup_processor` configuration option in `bin/config.py` accordingly. Your
+markup engine should accept text via `stdin` and output HTML on `stdout`.
+
+    apt-get install discount
+
+Edit `bin/config.py` and set all configuration options according to the steps
+taken during installation. Each option is commented inside the file.