mirror of
https://github.com/samsonjs/vdirsyncer.git
synced 2026-04-27 14:57:41 +00:00
Copy content of readme to docs
Because their content is going to diverge anyway
This commit is contained in:
parent
9a9c680248
commit
5f53d822f0
2 changed files with 26 additions and 5 deletions
|
|
@ -12,13 +12,9 @@ It aims to be for CalDAV and CardDAV what `OfflineIMAP
|
||||||
<http://offlineimap.org/>`_ is for IMAP.
|
<http://offlineimap.org/>`_ is for IMAP.
|
||||||
|
|
||||||
.. image:: https://travis-ci.org/untitaker/vdirsyncer.png?branch=master
|
.. image:: https://travis-ci.org/untitaker/vdirsyncer.png?branch=master
|
||||||
:width: 77px
|
|
||||||
:height: 19px
|
|
||||||
:target: https://travis-ci.org/untitaker/vdirsyncer
|
:target: https://travis-ci.org/untitaker/vdirsyncer
|
||||||
|
|
||||||
.. image:: https://coveralls.io/repos/untitaker/vdirsyncer/badge.png?branch=master
|
.. image:: https://coveralls.io/repos/untitaker/vdirsyncer/badge.png?branch=master
|
||||||
:width: 86px
|
|
||||||
:height: 18px
|
|
||||||
:target: https://coveralls.io/r/untitaker/vdirsyncer?branch=master
|
:target: https://coveralls.io/r/untitaker/vdirsyncer?branch=master
|
||||||
|
|
||||||
How to use
|
How to use
|
||||||
|
|
|
||||||
|
|
@ -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
|
Table of Contents
|
||||||
=================
|
=================
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue