aboutsummaryrefslogtreecommitdiffstats
path: root/docs/INSTALL
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2008-08-09 22:28:45 -0400
committerWaylan Limberg <waylan@gmail.com>2008-08-09 22:28:45 -0400
commitb941beb7973025d359f3e7839a5b99ea7f62c534 (patch)
tree5e069431bd0d6d4e1aec010a6bbf7f04269b4b24 /docs/INSTALL
parentfe8a2ff307ca2535e841e546cabfa31ce296d4ef (diff)
downloadmarkdown-b941beb7973025d359f3e7839a5b99ea7f62c534.tar.gz
markdown-b941beb7973025d359f3e7839a5b99ea7f62c534.tar.bz2
markdown-b941beb7973025d359f3e7839a5b99ea7f62c534.zip
Reorganized docs. Added an AUTHORS and INSTALL files. INSTALL is incomplete.
Diffstat (limited to 'docs/INSTALL')
-rw-r--r--docs/INSTALL59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/INSTALL b/docs/INSTALL
new file mode 100644
index 0000000..56d6c78
--- /dev/null
+++ b/docs/INSTALL
@@ -0,0 +1,59 @@
+Installing Python-Markdown
+==========================
+
+Checking Dependencies
+---------------------
+
+Python-Markdown requires the ElementTree module to be installed. In Python2.5+
+ElementTree is included as part of the standard library. For earlier versions
+of Python, open a Python shell and type the following:
+
+ >>> import cElementTree
+ >>> import ElementTree
+
+If at least one of those does not generate any errors, then you have a working
+copy of ElementTree installed on your system. As cElementTree is faster, you
+may want install that if you don't already have it and it's available for your
+system.
+
+The East Way
+------------
+
+The simplest way to install Python-Markdown is by using SetupTools. As and
+Admin/Root user on your system do:
+
+ easy_install ElementTree
+ easy_install Markdown
+
+That's it, your done.
+
+Installing on Windows
+---------------------
+
+
+
+Download the Windows installer (.exe) from PyPI:
+
+<http://pypi.python.org/pypi/Markdown>
+
+Doubleclick the file and follow the instructions.
+
+If you preffer to manually install Python-Markdown in Windows, download the
+Zip file, unzip it, and on the command line in the directory you unzipped to:
+
+ python setup.py install
+
+If you plan to use the provided commandline script, you need to make sure your
+script directory is on your system path. On a typical Python install on Windows
+the Scripts directory is `C:\Python25\Scripts\`. Adjust according to your
+system and add that to your system path.
+
+Installing on *nix Sytems
+-------------------------
+
+From the command line do the following:
+
+ wget http://pypi.python.org/packages/source/M/Markdown/markdown-2.0.tar.gz
+ tar xvzf markdown-2.0.tar.gz
+ cd markdown-2.0/
+ sudo python setup.py install