add installation instructions to README
This commit is contained in:
parent
7fdd18b294
commit
ebf222c51d
1 changed files with 16 additions and 0 deletions
16
README.md
16
README.md
|
@ -4,3 +4,19 @@ Woodwind
|
||||||
A minimum viable stream-style feed reader.
|
A minimum viable stream-style feed reader.
|
||||||
|
|
||||||
Supports mf2 h-feed and xml feeds (thanks to Universal Feed Parser).
|
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
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue