aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTimothy Hallett <thallett@gmail.com>2015-01-21 08:51:45 -0600
committerTimothy Hallett <thallett@gmail.com>2015-01-21 10:51:03 -0600
commitb4ec20b08b3251a8efafa3de7efc1115ac4d65f4 (patch)
tree732ab2be47344fabb80328a5e64946de912311d5 /README.md
parentebed06af0526486bcac973ca6f41c0a12c10a664 (diff)
downloadtask-git-b4ec20b08b3251a8efafa3de7efc1115ac4d65f4.tar.xz
task-git-b4ec20b08b3251a8efafa3de7efc1115ac4d65f4.zip
Usage modifications in README
Diffstat (limited to '')
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index ba6e3e1..599b4aa 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,15 @@ is altered.
## Usage
1. Navigate to your Taskwarrior data directory (usually in `~/.task`) and type `git init`. If you plan to push to a remote, go ahead and add your remote now.
-2. Add `alias task=/path/to/task-git/task-git.sh` to your `.bashrc` or
-`.profile`. If you want to push to a remote, then the alias should be `alias task=/path/to/task-git/task-git.sh --task-git-push`. Make sure you source the `.bashrc` or `.profile`.
+2. Add symlink to task-git.sh as /usr/bin/task-git
+
+ `ln -s /path/to/task-git/task-git.sh /usr/bin/task-git`
+
3. Run `chmod +x /path/to/task-git/task-git.sh`.
-4. Use `task` as normal; when run, the Taskwarrior database files will be committed to version control.
+4. Use `task-git` instead of `task` when you want the Taskwarrior database files to be automatically committed to version control after each operation.
+5. (Optional) Edit /etc/bash_completion.d/task to add this line to the end of the file so `task-git` will <TAB>-complete the same as `task`
+
+ `complete -o nospace -F _task task-git`
It is recommended to use the Taskwarrior database only on one machine, as you will be resolving conflicts if using the same task database on multiple machines.
@@ -18,6 +23,7 @@ It is recommended to use the Taskwarrior database only on one machine, as you wi
task-git.sh
Copyright (C) 2013 Kosta Harlan
+Copyright (C) 2015 Timothy Hallett (on modifications)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by