Commits

edgimar  committed ae6825f

- clean up the documentation some; include org-mode specific stuff

  • Participants
  • Parent commits 28a92e4

Comments (0)

Files changed (1)

-Michel is your friendly mate that helps you managing your todo list. It
-can push/pull flat text files to google tasks.
+Michel-orgmode is a fork of [michel](https://github.com/chmduquesne/michel)
+which serves as a bridge between an [org-mode](http://orgmode.org/) textfile
+and a google-tasks task list.  It can push/pull org-mode text files to/from
+google tasks.
 
 Usage
 =====
 Configuration
 -------------
 
-At the first run, you will be prompted an url. Click it, authorize michel.
+At the first run, you will be shown a URL. Click it, and authorize michel.
 You're done!
 
-The authorization token is stored in $XDG_DATA_HOME/michel/oauth.dat. This
+The authorization token is stored in `$XDG_DATA_HOME/michel/oauth.dat`. This
 is the only information stored.
 
 Commands
 --------
 
-Michel keeps it stupid simple. It only has two commands:
+Michel keeps it simple. It only has two commands:
 
-    michel pull
-Print the default todo list on the standard output
+    michel pull [list name]
+Print the named (or default if no name is given) task list on the standard
+output.
 
-    michel push <TODO.txt>
-Replace the default todo list with the content of TODO.txt
-
-Non features
-------------
-
-Michel aims at being simple: it does not handle due dates nor notes.
+    michel push <TODO.org> [list name]
+Replace the named (or default if no name is given) task list with the contents
+of TODO.org
 
 Syntax
 ------
 
-One line is one task. tab-indented lines (with the real tab character)
-are subtasks of the "parent" line.
+This script currently only supports a subset of the org-mode format.  The
+following elements are mapped mapped between google-tasks and an org-mode file:
+
+* Indented Tasks <-> Number of preceding asterisks
+* Task Notes <-> Headline's body text
+* Checked-off / crossed-out <-> Headline is marked as DONE
 
 How to
 ------
 does not contains /usr/local/bin in crontab. You might want to set it
 manually. See 'man 5 crontab'.
 
-Installing
-==========
-
-install python-xdg, then run
-
-    pip install michel
-
 About
 =====
 
 
 - License: Public Domain
 - Original author: Christophe-Marie Duquesne ([blog post](http://blog.chmd.fr/releasing-michel-a-flat-text-file-to-google-tasks-uploader.html))
+- Author of org-mode version: Mark Edgington ([bitbucket site](https://bitbucket.org/edgimar/michel-orgmode))
 
 Contributing
 ------------