From: Sean Hammond <seanh@sdf.lonestar.org>
Date: Tue, 14 Jul 2009 11:49:38 +0000 (+0100)
Subject: Adding a README file for github's benefit.
X-Git-Url: https://projects.mako.cc/source/pyblosxom-markdown2/commitdiff_plain/5bfcb90d8868faf2c8e718d81f734979296b9dee?ds=sidebyside

Adding a README file for github's benefit.
---

diff --git a/README b/README
new file mode 100644
index 0000000..7d4f1e4
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+markdown-plugin.py -- A python-markdown 2 plugin for pyblosxom.
+
+This plugin requires python-markdown 2, which you can download from:
+
+    http://www.freewisdom.org/projects/python-markdown/
+
+Extract python-markdown 2 into your pyblosxom plugins dir alongside this 
+plugin. Your plugins dir should look like this:
+
+    plugins/ <-- your pyblosxom plugins dir
+        markdown-plugin.py <-- this file
+        markdown.py <-- the python-markdown command line script
+        markdown/ <-- directory containing python-markdown's files
+        ... <-- (any other pyblosxom plugins)
+
+Now any posts with filenames ending in `.mkdn` will be passed through 
+python-markdown.
+   
+Copyright (C) Benjamin Mako Hill, 2005
+Updated for python-markdown 2 by seanh 2009
+
+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
+the Free Software Foundation; either version 2 of the License, or (at
+your option) any later versi
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.