diff options
| author | Waylan Limberg <waylan@gmail.com> | 2011-08-23 10:53:49 -0400 |
|---|---|---|
| committer | Waylan Limberg <waylan@gmail.com> | 2011-08-23 10:53:49 -0400 |
| commit | a6fd7b5cba69cad049046b3a372d0f2d6c495abe (patch) | |
| tree | 42a8987d08eb5a05eb2b3cb1399540583e8cbf67 /README.md | |
| parent | e5b2813bbf02710c7deb148896085a3dac4828dc (diff) | |
| download | markdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.tar.gz markdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.tar.bz2 markdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.zip | |
Renamed *.txt -> *.md in docs.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a429619 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +[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://github.com/waylan/Python-Markdown/issues + |