Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Move README to an org-mode file, as it seems more fitting.

  • Loading branch information...
commit 27af28a8bd5753543a1e9abb1f162d2c7e5a3473 1 parent 2c76092
Albin Stjerna authored
Showing with 32 additions and 35 deletions.
  1. +0 −35 README
  2. +32 −0 README.org
View
35 README
@@ -1,35 +0,0 @@
-.. -*- restructuredtext -*-
-
-==================
-README for Orgnode
-==================
-
-Orgnode
-=======
-
-"`Orgnode - reading org-mode in Python`_" is originally developed by
-`Charles Cave`_. This is a fork by Takafumi Arakaki, with some minor
-fixes by Albin Stjerna.
-
-.. _`Charles Cave`:
- http://members.optusnet.com.au/~charles57/GTD/
-.. _`Orgnode - reading org-mode in Python`:
- http://members.optusnet.com.au/~charles57/GTD/orgnode.html
-
-
-How to use
-==========
-
-Just set the Orgnode.py where your python can import this module.
-
-Differences to Araraki's and Cave's versions
-============================================
-
-So far, the only thing I've really done is adding a few test cases and
-fixing a bug in one of the regular expressions that would produce
-incorrect results when a TODO keyword appeared inside a paragraph. I
-do, however, intend to use orgnode, and improve on it when I find
-bugs.
-
-As far as I can tell, Araraki's verison is a significant improvement
-over Cave's, fixing proper unicode handling among other things.
View
32 README.org
@@ -0,0 +1,32 @@
+* Orgnode
+[[http://members.optusnet.com.au/~charles57/GTD/orgnode.html][»Orgnode - reading org-mode in Python«]] was originally developed by
+[[http://members.optusnet.com.au/~charles57/GTD/][Charles Cave]]. This is a fork by Takafumi Arakaki, with some minor
+fixes by Albin Stjerna.
+* How to use
+Just set the =Orgnode.py= where your python can import this module.
+
+Some samples (directly from Cave's version):
+#+begin_src python
+import Orgnode, datetime
+
+today = datetime.date.today()
+print "Daily plan for", today
+print "-------------------------\n"
+
+filename = "c:/charles/GTD/newgtd.org"
+nodelist = Orgnode.makelist(filename)
+
+for n in nodelist:
+ if n.Scheduled() == today:
+ print "[ ] %s (%s)" % (n.Heading(), n.Tag() )
+#+end_src
+
+* Differences to Araraki's and Cave's versions
+So far, the only thing I've really done is adding a few test cases and
+fixing a bug in one of the regular expressions that would produce
+incorrect results when a TODO keyword appeared inside a paragraph. I
+do, however, intend to use orgnode, and improve on it when I find
+bugs.
+
+As far as I can tell, Araraki's verison is a significant improvement
+over Cave's, fixing proper unicode handling among other things.
Please sign in to comment.
Something went wrong with that request. Please try again.