diff options
author | Waylan Limberg <waylan@gmail.com> | 2008-08-09 22:28:45 -0400 |
---|---|---|
committer | Waylan Limberg <waylan@gmail.com> | 2008-08-09 22:28:45 -0400 |
commit | b941beb7973025d359f3e7839a5b99ea7f62c534 (patch) | |
tree | 5e069431bd0d6d4e1aec010a6bbf7f04269b4b24 | |
parent | fe8a2ff307ca2535e841e546cabfa31ce296d4ef (diff) | |
download | markdown-b941beb7973025d359f3e7839a5b99ea7f62c534.tar.gz markdown-b941beb7973025d359f3e7839a5b99ea7f62c534.tar.bz2 markdown-b941beb7973025d359f3e7839a5b99ea7f62c534.zip |
Reorganized docs. Added an AUTHORS and INSTALL files. INSTALL is incomplete.
-rw-r--r-- | docs/AUTHORS | 36 | ||||
-rw-r--r-- | docs/CHANGE_LOG (renamed from CHANGE_LOG.txt) | 0 | ||||
-rw-r--r-- | docs/INSTALL | 59 | ||||
-rw-r--r-- | docs/MANIFEST (renamed from MANIFEST) | 12 | ||||
-rw-r--r-- | docs/README (renamed from README.txt) | 0 | ||||
-rw-r--r-- | docs/README.html (renamed from README.html) | 0 | ||||
-rw-r--r-- | docs/writing_extensions.txt (renamed from writing_extensions.txt) | 0 | ||||
-rw-r--r-- | scripts/odt2txt.py (renamed from odt2txt.py) | 0 |
8 files changed, 103 insertions, 4 deletions
diff --git a/docs/AUTHORS b/docs/AUTHORS new file mode 100644 index 0000000..b4cd939 --- /dev/null +++ b/docs/AUTHORS @@ -0,0 +1,36 @@ +Primary Authors +=============== + +Yuri Takteyev <http://freewisdom.org/>, who has written much of the current code +while procrastingating his Ph.D. + +Waylan Limberg <http://achinghead.com/>, who has written most of the available +extensions and later was asked to join Yuri, fixing nummrious bugs, adding +documentation and making general improvements to the existing codebase. + +Artem Yunusov, who as part of a 2008 GSoC project, has refactored inline +patterns, replaced the NanoDOM with ElementTree support and made various other +improvements. + +Manfed Stienstra <http://www.dwerg.net/>, who wrote the original version of +the script and is responsible for various parts of the existing codebase. + +David Wolever, who refactored the extension API and made other improvements +as he helped to integrate Markdown into Dr.Project. + +Other Contributors +================== + +The incomplete list of individuals below have provided patches +or otherwise contributed to the project in various ways. We would like to thank +everyone who has contributed to the progect in any way. + +Jeff Balogh +Sergej Chodarev +Chris Clark +Tiago Cogumbreiro +G. Clark Haynes +Daniel Krech +Steward Midwinter +Malcolm Tredinnick +and many others to helped by reporting bugs diff --git a/CHANGE_LOG.txt b/docs/CHANGE_LOG index 200d5b7..200d5b7 100644 --- a/CHANGE_LOG.txt +++ b/docs/CHANGE_LOG diff --git a/docs/INSTALL b/docs/INSTALL new file mode 100644 index 0000000..56d6c78 --- /dev/null +++ b/docs/INSTALL @@ -0,0 +1,59 @@ +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 install that if you don't already have it and it's available for your +system. + +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> + +Doubleclick the file and follow the instructions. + +If you preffer 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 commandline script, you need to make sure your +script directory is on your system path. On a typical Python install on Windows +the Scripts directory is `C:\Python25\Scripts\`. Adjust according to your +system and add that to your system path. + +Installing on *nix Sytems +------------------------- + +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 @@ -1,6 +1,3 @@ -README.txt -README.html -CHANGE_LOG.txt markdown.py mdx_codehilite.py mdx_fenced_code.py @@ -12,4 +9,11 @@ mdx_rss.py mdx_tables.py mdx_wikilink.py setup.py -scripts/pymarkdown.py
\ No newline at end of file +scripts/pymarkdown.py +docs/README +docs/README.html +docs/CHANGE_LOG +docs/INSTALL +docs/AUTHORS +docs/writing_extensions.txt + diff --git a/README.html b/docs/README.html index 6d94e8e..6d94e8e 100644 --- a/README.html +++ b/docs/README.html diff --git a/writing_extensions.txt b/docs/writing_extensions.txt index 2ae279c..2ae279c 100644 --- a/writing_extensions.txt +++ b/docs/writing_extensions.txt diff --git a/odt2txt.py b/scripts/odt2txt.py index bb8fab0..bb8fab0 100644 --- a/odt2txt.py +++ b/scripts/odt2txt.py |