Commit ae0fd84d authored by Sriram Karra's avatar Sriram Karra

Add a note in the README about updating git sub-modules

parent cf2363df
......@@ -38,12 +38,23 @@ that website.
- It is free software, and released under the GNU AGPL (Affero GPL) version
* Installation & Usage
* Installation
As you are reading this file, the most efficient installation is to clone this
git repository to your machine. Then see the section titled Usage below to
invoke ASynK.
** Updating an earlier install
If you are updating your ASynK installation from an earlier version,
please note that many new git-submodules are added to the project. So for
your update to work properly you need to update all
sub-modules. Recommended way to do this would be to fun the following
command from the root of your ASynK directory, after you pull in the latest
: git submodule update --init --recursive
** Dependencies
ASynK is completely written in Python. For most use cases and set ups you
......@@ -63,7 +74,7 @@ invoke ASynK.
- The dateutil package available from or
** Usage
* Usage
The recommended way to use ASynK is to first create your own 'sync profile'
which specifies which folders and PIM DBs you want to keep in sync. Refer
......@@ -71,8 +82,8 @@ invoke ASynK.
For the really impatient, ASynK comes with two default sync profiles that
kick in if no other profile is configured.
$ python --op=sync [--dry-run] [--log=debug]
: $ python --op=sync [--dry-run] [--log=debug]
If you run the above command on Windows, the entire default outlook
contacts folder will get synched to "My Contacts" on Google Contacts. (You
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment