X-Git-Url: http://git.subgeniuskitty.com/cmless/.git/blobdiff_plain/a58599bae29dd31138843285dcbe638bb911b0d3..73c5dba96df5b81d7e05ec9a75e81306c709883b:/README.md diff --git a/README.md b/README.md index 0a9853a..47faa0d 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,11 @@ Status 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 +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 ----------------------------------- @@ -55,6 +56,7 @@ vi /etc/apache2/sites-available/cmless.subgeniuskitty.com 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 ``` @@ -72,9 +74,24 @@ 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. +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.