added installation instructions and python version to readme

This commit is contained in:
JesseBot 2016-01-03 22:05:39 +00:00
parent ca664edc4d
commit 2c37988193

View file

@ -3,7 +3,7 @@ tiny_personal_website
This is a Python based CMS for a small personal website. The back end uses
the bottle web framework and the front end is bootstrap. YAML is used for site
specific configurations.
specific configurations. Tested with Python 2.7 only.
Setup
@ -11,11 +11,13 @@ Setup
1. Clone this github repo into your desired webroot.
2. You can configure everything (e.g. the webroot absolute path, your photo,
2. Install missing libraries if any: `pip install -r requirements.txt`
3. You can configure everything (e.g. the webroot absolute path, your photo,
quote, etc) by renaming `config/config.yaml.sample` to `config.yaml` and
replacing all the sample data with your own real data.
3. The website assumes you're running on a Linux server with apache. I use the
4. The website assumes you're running on a Linux server with apache. I use the
[mod_wsgi](https://github.com/GrahamDumpleton/mod_wsgi) apache module to
deliver this content.
..* In `config/example.com.conf` I have an example apache
@ -25,7 +27,7 @@ virutal host config. I recommend creating a special user and group for this
apache config. You may also need to modify permissions for the socket file if
you are running CentOS/RHEL, which will live in `/var/run/http`.
4. All changes to HTML, CSS, JS, Python, or your core YAML will require an
5. All changes to HTML, CSS, JS, Python, or your core YAML will require an
apache restart.