aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README
diff options
context:
space:
mode:
authorArtem Yunusov <nedrlab@gmail.com>2008-10-16 14:56:13 +0500
committerArtem Yunusov <nedrlab@gmail.com>2008-10-16 14:56:13 +0500
commitde7a7403dd2707e3fcd36a35e68b6bffa7621920 (patch)
tree7d23a55dccaaa86c2db200de11b48e084459c05c /docs/README
parentcf1ab89854cdf75a8f658861a7c0133158737385 (diff)
parent099ab5e47d9b52aed5c6752a96e030e59bbbc977 (diff)
downloadmarkdown-de7a7403dd2707e3fcd36a35e68b6bffa7621920.tar.gz
markdown-de7a7403dd2707e3fcd36a35e68b6bffa7621920.tar.bz2
markdown-de7a7403dd2707e3fcd36a35e68b6bffa7621920.zip
Merge branch 'master' of git://gitorious.org/python-markdown/mainline
Diffstat (limited to 'docs/README')
-rw-r--r--docs/README80
1 files changed, 6 insertions, 74 deletions
diff --git a/docs/README b/docs/README
index b859924..d19a1ea 100644
--- a/docs/README
+++ b/docs/README
@@ -13,46 +13,12 @@ supported by the [Available Extensions][].
[Available Extensions]: http://www.freewisdom.org/projects/python-markdown/Available_Extensions
-Installation
-------------
+Documentation
+-------------
-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 <input_file>
-
-or
-
- python markdown.py <input_file> > <output_file>
-
-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
+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
-------
@@ -60,39 +26,5 @@ 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 `<hr/>` tags.
-* Chris Clark submitted a patch to handle `<mailto:...>` 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.
+[bug tracker]: http://www.freewisdom.org/projects/python-markdown/Tickets
-[GPL]: http://www.gnu.org/copyleft/gpl.html)
-[BSD License]: http://www.opensource.org/licenses/bsd-license.php