1Installing Python-Markdown
2==========================
3
4Checking Dependencies
5---------------------
6
7Python-Markdown requires the ElementTree module to be installed. In Python2.5+
8ElementTree is included as part of the standard library. For earlier versions
9of Python, open a Python shell and type the following:
10
11    >>> import cElementTree
12    >>> import ElementTree
13
14If at least one of those does not generate any errors, then you have a working
15copy of ElementTree installed on your system. As cElementTree is faster, you
16may want to install that if you don't already have it and it's available for
17your system.
18
19See <http://effbot.org/zone/element-index.htm> for more information or to
20download the latest version of ElementTree.
21
22The East Way
23------------
24
25The simplest way to install Python-Markdown is by using SetupTools. As and
26Admin/Root user on your system do:
27
28    easy_install ElementTree
29    easy_install Markdown
30
31That's it, your done.
32
33Installing on Windows
34---------------------
35
36Download the Windows installer (.exe) from PyPI:
37<http://pypi.python.org/pypi/Markdown>
38
39Double-click the file and follow the instructions.
40
41If you prefer to manually install Python-Markdown in Windows, download the
42Zip file, unzip it, and on the command line in the directory you unzipped to:
43
44    python setup.py install
45
46If you plan to use the provided command line script, you need to make sure your
47script directory is on your system path. On a typical Python install of Windows
48the Scripts directory is `C:\Python25\Scripts\`. Adjust according to your
49system and add that to your system path.
50
51Installing on *nix Systems
52--------------------------
53
54From the command line do the following:
55
56    wget http://pypi.python.org/packages/source/M/Markdown/Markdown-2.0.tar.gz
57    tar xvzf Markdown-2.0.tar.gz
58    cd markdown-2.0/
59    sudo python setup.py install
60
61Using the Git Repository
62------------------------
63
64If your the type that like to live on the edge, you may want to keep up with
65the latest additions and bug fixes in the repository between releases.
66Python-Markdown is maintained in a Git repository on Gitorious.org. To
67get a copy of Python-Markdown from the repository do the following from the
68command line:
69
70    git clone git://gitorious.org/python-markdown/mainline.git python-markdown
71    cd python-markdown
72    python setup.py install
73
74