Add test suite instructions

This commit is contained in:
Markus Unterwaditzer 2014-03-01 20:39:59 +01:00
parent 78065a4e1f
commit 0e9c5a9130
4 changed files with 13 additions and 2 deletions

2
.gitignore vendored
View file

@ -2,3 +2,5 @@
__pycache__
htmlcov
.coverage
build
env

View file

@ -3,10 +3,16 @@ This is work-in-progress.
A basic syncronization utility for [vdir](https://github.com/untitaker/vdir).
Should be able to sync both CardDAV and CalDAV in the end.
## How to run
## How to use
Copy `config.example` to `~/.vdirsyncer/config` and edit it. You can use the
`VDIRSYNCER_CONFIG` environment variable to change the path vdirsyncer will
read the config from.
Run `vdirsyncer --help`.
## How to run the tests
pip install .
pip install -r dev_requirements.txt
py.test

3
dev_requirements.txt Normal file
View file

@ -0,0 +1,3 @@
Radicale
Werkzeug
pytest

View file

@ -25,5 +25,5 @@ setup(
entry_points={
'console_scripts': ['vdirsyncer = vdirsyncer.cli:main']
},
install_requires=['argvard', 'requests']
install_requires=['argvard', 'requests', 'lxml']
)