aboutsummaryrefslogtreecommitdiffstats
path: root/docs/install.md
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
committerWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
commitec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 (patch)
tree9c1b9c5025948204e415a21938469bf50bbae754 /docs/install.md
parent9fd4a5f1600c96406ad0fb86b1a8287d525972ac (diff)
downloadmarkdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.gz
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.bz2
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.zip
Rename docs/*.md => docs/*.txt
The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension.
Diffstat (limited to 'docs/install.md')
-rw-r--r--docs/install.md83
1 files changed, 0 insertions, 83 deletions
diff --git a/docs/install.md b/docs/install.md
deleted file mode 100644
index cb20a73..0000000
--- a/docs/install.md
+++ /dev/null
@@ -1,83 +0,0 @@
-title: Installation
-prev_title: Summary
-prev_url: index.html
-next_title: Library Reference
-next_url: reference.html
-
-Installing Python-Markdown
-==========================
-
-The Easy Way
-------------
-
-The easiest way to install Python-Markdown is simply to type one of the
-following commands from the command line as an Admin/Root user:
-
- pip install markdown
-
-or
-
- easy_install markdown
-
-That's it! Your ready to [use](reference.html) Python-Markdown. Enjoy!
-
-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,
-run the following command:
-
- C://path/to/python.exe 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:\PythonXX\Scripts\` (were "XX" is the Python version
-number, i.e., "27"). Adjust the path according to your system and add to your
-system path.
-
-Installing on *nix Systems
---------------------------
-
-From the command line do the following (where 2.x is the version number):
-
- wget http://pypi.python.org/packages/source/M/Markdown/Markdown-2.x.tar.gz
- tar xvzf Markdown-2.x.tar.gz
- cd markdown-2.x/
- sudo python setup.py install
-
-See [PyPI](http://pypi.python.org/pypi/Markdown) for all available versions.
-
-Using the Git Repository
-------------------------
-
-If you're the type that likes 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 github.com. To
-get a copy of Python-Markdown from the repository do the following from the
-command line:
-
- git clone git://github.com/waylan/Python-Markdown.git python-markdown
- cd python-markdown
- python setup.py install
-
-Dependencies
-------------
-
-Python-Markdown requires the ElementTree module to be installed. In Python 2.5+
-ElementTree is included as part of the standard library at
-`xml.etree.ElementTree` and/or `xml.etree.cElementTree`. For earlier versions
-of Python, the library needs to be installed. However, Python-Markdown's
-install script will automaticaly detect the missing library and download and
-install the "ElementTree" library for you if your system has internet access.
-If you would like to use the "cElementTree" library (which is faster), you can
-install it manually. Markdown will check for the faster "c" library first and
-fall back to the slower python implementation when it is not available.
-
-See <http://effbot.org/zone/element-index.htm> for more information or to
-download the latest version of ElementTree.