[tasks] 06/07: Add documentation about this repo

[Ximin Luo]

This is an automated email from the git hooks/post-receive script.

infinity0 pushed a commit to branch master
in repository tasks.

commit 83237a8f960a3dc6a12daa61ef0da22113666d95
Author: Ximin Luo <infinity0 at debian.org>
Date:   Mon Oct 24 18:14:04 2016 +0200

    Add documentation about this repo
---
 README | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README b/README
index 1ad6679..1b1440e 100644
--- a/README
+++ b/README
@@ -3,8 +3,25 @@ You need the `taskwarrior` program to use this repo.
 https://packages.debian.org/sid/taskwarrior
 
 But don't run /usr/bin/task, run ./task instead. That includes some presets to
-work directly inside this repo, instead of your ~/.task directory.
+work directly inside this repo, instead of your ~/.task directory. It also
+includes the task-history-git plugin, which helps taskwarrior to work more
+smoothly when its data is stored inside a git repo.
 
-Please take some time to read the docs here:
+If you're not familiar with it, please take some time to read the docs here:
 
 https://taskwarrior.org/docs/
+
+IMPORTANT
+=========
+
+In Taskwarrior, every task has a simple numerical ID (1, 2, 3, etc) and a UUID.
+Taskwarrior will reassign numerical IDs by default; however this repository has
+been configured so it will not do that, and once a numerical ID has been
+assigned to a task, it should be stable for all of eternity.
+
+THERE IS ONE EXCEPTION TO THIS: If you add a task locally, then pull from our
+central task repo, other tasks might have been added in the meantime. To
+prevent re-assignment of already-published numerical tasks, you MUST, when you
+perform a merge conflict resolution, put the unpublished tasks that you added
+locally, *after* the ones that have already been published and that you just
+pulled down from the remote side.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/tasks.git