Added config.py and edited README.md to reflect new installation steps.
authorAaron Taylor <ataylor@subgeniuskitty.com>
Sat, 6 Jan 2018 01:27:20 +0000 (17:27 -0800)
committerAaron Taylor <ataylor@subgeniuskitty.com>
Sat, 6 Jan 2018 01:27:20 +0000 (17:27 -0800)
README.md
bin/config.py [new file with mode: 0644]

index 0a9853a..97ceff0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -72,9 +72,24 @@ git clone https://github.com/subgeniuskitty/cmless.git cmless.subgeniuskitty.com
 chown -R www-data:www-data ./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
 
 ```
 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.
diff --git a/bin/config.py b/bin/config.py
new file mode 100644 (file)
index 0000000..3c196a1
--- /dev/null
@@ -0,0 +1,19 @@
+# (c) 2017 Aaron Taylor <ataylor at subgeniuskitty dot com>
+# See LICENSE file for copyright and license details.
+
+#####
+# CMless Configuration Options
+#####
+
+# The prefix to the website content relative to the bin/ folder which contains
+# the CMless code.
+site_path_prefix = "../site"
+
+# Full path to the markup processor which can interpret the data files in
+# site_path_prefix and output HTML. It should accept markup data on stdin and
+# output HTML on stdout.
+markup_processor = "/usr/bin/markdown"
+
+# File extension associated with the markup format used by the data files in
+# site_path_prefix.
+markup_file_extension = ".md"