diff --git a/README.md b/README.md index 70254e2..754fb57 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,27 @@ 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. +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 +``` + +Set up the virtualenv and install dependencies. + +```bash virtualenv --python=/usr/bin/python3 venv pip install -r requirements.txt +``` + +Use the basic SQLite configuration, create database tables and run Woodwind. + +```bash cp woodwind.cfg.template woodwind.cfg python init_db.py uwsgi woodwind-dev.ini ``` + +Now visit localhost:3000, and you should see the login screen!