From b941beb7973025d359f3e7839a5b99ea7f62c534 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Sat, 9 Aug 2008 22:28:45 -0400 Subject: Reorganized docs. Added an AUTHORS and INSTALL files. INSTALL is incomplete. --- README.txt | 98 -------------------------------------------------------------- 1 file changed, 98 deletions(-) delete mode 100644 README.txt (limited to 'README.txt') diff --git a/README.txt b/README.txt deleted file mode 100644 index b859924..0000000 --- a/README.txt +++ /dev/null @@ -1,98 +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 - - -Installation ------------- - -To install Python Markdown [download][] the zip file and extract the -files. If you want to install markdown as a module into your python -tree, run `sudo python setup.py install` from a directory where you -unzip the files. - -[download]: http://sourceforge.net/project/showfiles.php?group_id=153041 - - -Command Line Usage ------------------- - -To use markdown.py from the command line, run it as - - python markdown.py - -or - - python markdown.py > - -For more details, use the `-h` or `--help` options from the command line -or read the [Command Line Docs][] available online. - -[Command Line Docs]: http://www.freewisdom.org/projects/python-markdown/Command_Line - - - -Using as a Python Module ------------------------- - -To use markdown as a module: - - import markdown - html = markdown.markdown(your_text_string) - -For more details see the [Module Docs][]. - -[Module Docs]: http://www.freewisdom.org/projects/python-markdown/Using_as_a_Module - -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://sourceforge.net/tracker/?func=add&group_id=153041&atid=790198 - - -Credits -------- - -* Most of the code currently in the module was written by [Yuri Takhteyev][] - while procrastinating from his Ph.D. -* The original version of this script was written by [Manfred Stienstra][], - who is responsible for about a quarter of the code. -* Many recent bugs are being fixed by [Waylan Limberg][]. - -Other contributions: - -* Daniel Krech provided the setup.py script. -* G. Clark Haynes submitted a patch for indented lists. -* Tiago Cogumbreiro submitted an email autolink fix. -* Sergej Chodarev submitted a patch for treatment of `
` tags. -* Chris Clark submitted a patch to handle `` syntax and a reg ex - for "smart" emphasis (ignoring underscores within a word). -* Steward Midwinter wrote command-line parser and cleaned up comments. -* Many other people helped by reporting bugs. - -[Yuri Takhteyev]: http://www.freewisdom.org -[Manfred Stienstra]: http://www.dwerg.net/ -[Waylan Limberg]: http://achinghead.com/ - - -License -------- - -The code is dual-licensed under [GPL][] and [BSD License][]. Other -licensing arrangements can be discussed. - -[GPL]: http://www.gnu.org/copyleft/gpl.html) -[BSD License]: http://www.opensource.org/licenses/bsd-license.php -- cgit v1.2.3