sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-03-25 08:55:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Copy content of readme to docs

Browse source 
Because their content is going to diverge anyway
This commit is contained in:
Markus Unterwaditzer 2014-05-19 19:02:22 +02:00
parent 9a9c680248
commit 5f53d822f0
2 changed files with 26 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.rst
View file

@ -12,13 +12,9 @@ It aims to be for CalDAV and CardDAV what `OfflineIMAP
<http://offlineimap.org/>`_ is for IMAP.
.. image:: https://travis-ci.org/untitaker/vdirsyncer.png?branch=master
:width: 77px
:height: 19px
:target: https://travis-ci.org/untitaker/vdirsyncer
.. image:: https://coveralls.io/repos/untitaker/vdirsyncer/badge.png?branch=master
:width: 86px
:height: 18px
:target: https://coveralls.io/r/untitaker/vdirsyncer?branch=master
How to use

27
docs/index.rst
View file

@ -1,4 +1,29 @@
.. include:: ../README.rst
==========
vdirsyncer
==========
vdirsyncer synchronizes your calendars and addressbooks between two storages.
The supported storages are CalDAV, CardDAV, arbitrary HTTP resources, `vdir
<https://github.com/untitaker/vdir>`_ and some more. The documentation contains
a full `list of supported storages <storages>`.
It aims to be for CalDAV and CardDAV what `OfflineIMAP
<http://offlineimap.org/>`_ is for IMAP.
How to use
==========
vdirsyncer requires Python >= 2.7 or Python >= 3.3.
As all Python packages, vdirsyncer can be installed with ``pip``::
pip install --user vdirsyncer
Then copy ``example.cfg`` 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`` and read on:
Table of Contents
=================