edgimar avatar edgimar committed ba08344

- added dependency list to documentation

Comments (0)

Files changed (1)

 
 Michel keeps it simple. It only has two commands:
 
-    michel pull [list name]
+    michel.py pull [list name]
 Print the named (or default if no name is given) task list on the standard
 output.
 
-    michel push <TODO.org> [list name]
+    michel.py push <TODO.org> [list name]
 Replace the named (or default if no name is given) task list with the contents
 of TODO.org
 
 default TODO list, and another one displays a notification during 10
 seconds every hour (requires notify-send).
 
-    */15 * * * * michel pull > /tmp/TODO && mv /tmp/TODO ~/.TODO
+    */15 * * * * /path/to/michel.py pull > /tmp/TODO && mv /tmp/TODO ~/.TODO
     0 * * * * DISPLAY=":0.0" notify-send -t 10000 TODO "$(cat ~/.TODO)"
 
 After you modify your TODO list, don't forget to push it!
 
-    michel push .TODO
+    michel.py push .TODO
 
 If this trick is not working, it is probably because the variable PATH
 does not contains /usr/local/bin in crontab. You might want to set it
 manually. See 'man 5 crontab'.
 
+Installation Dependencies
+=========================
+
+The `michel.py` script runs under Linux (not tested on other platforms yet).
+To run the script, you need to install the following dependencies:
+
+* [google-api-python-client](http://code.google.com/p/google-api-python-client/)
+* [python-gflags](http://code.google.com/p/python-gflags/) (usually available in
+  package repositories of major linux distributions)
+
+
 About
 =====
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.