add installation instructions to README

This commit is contained in:
Kyle Mahan 2015-08-14 08:18:38 -07:00
parent 7fdd18b294
commit ebf222c51d

View file

@ -4,3 +4,19 @@ Woodwind
A minimum viable stream-style feed reader.
Supports mf2 h-feed and xml feeds (thanks to Universal Feed Parser).
Installation
----------
How to run your own instance of Woodwind. The default configuration uses
SQLite, so no database setup is necessary.
```bash
git clone https://github.com/kylewm/woodwind.git
cd woodwind
virtualenv --python=/usr/bin/python3 venv
pip install -r requirements.txt
cp woodwind.cfg.template woodwind.cfg
python init_db.py
uwsgi woodwind-dev.ini
```