diff options
author | Jean-Baptiste Queru <jbq@google.com> | 2011-02-04 14:12:08 -0800 |
---|---|---|
committer | Jean-Baptiste Queru <jbq@google.com> | 2011-02-04 14:12:08 -0800 |
commit | 6516b99bb74dfb7187a08f7090bf7ca22a006f15 (patch) | |
tree | 2cda04a3eee460c97f0411722bce3e9d9e54663d /docs/INSTALL | |
parent | e46e2414e0d5f0405da714c6531c176643aed09c (diff) | |
download | markdown-6516b99bb74dfb7187a08f7090bf7ca22a006f15.tar.gz |
Import python-markdown
This is from git://gitorious.org/python-markdown/mainline.git
at tag 2.0.3 (commit 067d88bc41c7924c9087b724ff5247235243ce6b)
Change-Id: I5091438ce3243b87a099b8a75dd6307921966e76
Diffstat (limited to 'docs/INSTALL')
-rw-r--r-- | docs/INSTALL | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/INSTALL b/docs/INSTALL new file mode 100644 index 0000000..d8feade --- /dev/null +++ b/docs/INSTALL @@ -0,0 +1,73 @@ +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 to install that if you don't already have it and it's available for +your system. + +See <http://effbot.org/zone/element-index.htm> for more information or to +download the latest version of ElementTree. + +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> + +Double-click the file and follow the instructions. + +If you prefer 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 command line script, you need to make sure your +script directory is on your system path. On a typical Python install of Windows +the Scripts directory is `C:\Python25\Scripts\`. Adjust according to your +system and add that to your system path. + +Installing on *nix Systems +-------------------------- + +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 + +Using the Git Repository +------------------------ + +If your the type that like to live on the edge, you may want to keep up with +the latest additions and bug fixes in the repository between releases. +Python-Markdown is maintained in a Git repository on Gitorious.org. To +get a copy of Python-Markdown from the repository do the following from the +command line: + + git clone git://gitorious.org/python-markdown/mainline.git python-markdown + cd python-markdown + python setup.py install + |