README: skeleton, including dependency and conffile information

This commit is contained in:
Stefano Zacchiroli 2015-04-26 15:19:00 +02:00
parent bf08743356
commit 9a1bab27cb

21
README Normal file
View file

@ -0,0 +1,21 @@
Dependencies
============
- python3
- python3-sqlalchemy
- python3-requests
Configuration file
==================
cat ~/.config/ghlister.ini
[main]
# see http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls
db_url = postgres:///github
cache_dir = cache
log_dir = log
username = foobar
password = quux