From 3d2cdeeddc77f3c226ad59eef95f9070835c60ab Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 24 Mar 2010 22:59:48 -0400 Subject: Moved INSTALL, LICENSE and README files out of docs dir and into root dir where they should be. --- INSTALL | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 INSTALL (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..d8feade --- /dev/null +++ b/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 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: + + +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 + -- cgit v1.2.3