diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/INSTALL | 73 | ||||
| -rw-r--r-- | docs/LICENSE | 30 | ||||
| -rw-r--r-- | docs/README | 30 |
3 files changed, 0 insertions, 133 deletions
diff --git a/docs/INSTALL b/docs/INSTALL deleted file mode 100644 index d8feade..0000000 --- a/docs/INSTALL +++ /dev/null @@ -1,73 +0,0 @@ -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 - diff --git a/docs/LICENSE b/docs/LICENSE deleted file mode 100644 index 4cd8b14..0000000 --- a/docs/LICENSE +++ /dev/null @@ -1,30 +0,0 @@ -Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later) -Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) -Copyright 2004 Manfred Stienstra (the original version) - -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. -* Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. -* Neither the name of the <organization> nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY -EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTORS TO THE PYTHON MARKDOWN PROJECT -BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. - diff --git a/docs/README b/docs/README deleted file mode 100644 index d19a1ea..0000000 --- a/docs/README +++ /dev/null @@ -1,30 +0,0 @@ -[Python-Markdown][] -=================== - -This is a Python implementation of John Gruber's [Markdown][]. -It is almost completely compliant with the reference implementation, -though there are a few known issues. See [Features][] for information -on what exactly is supported and what is not. Additional features are -supported by the [Available Extensions][]. - -[Python-Markdown]: http://freewisdom.org/projects/python-markdown -[Markdown]: http://daringfireball.net/projects/markdown/ -[Features]: http://www.freewisdom.org/projects/python-markdown/Features -[Available Extensions]: http://www.freewisdom.org/projects/python-markdown/Available_Extensions - - -Documentation -------------- - -Installation and usage documentation is available in the `docs/` directory -of the distribution and on the project website at -<http://freewisdom.org/projects/python-markdown>. - -Support -------- - -You may ask for help and discuss various other issues on the [mailing list][] and report bugs on the [bug tracker][]. - -[mailing list]: http://lists.sourceforge.net/lists/listinfo/python-markdown-discuss -[bug tracker]: http://www.freewisdom.org/projects/python-markdown/Tickets - |