summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-09-20 21:12:48 +0200
committerGeorg Brandl <georg@python.org>2014-09-20 21:12:48 +0200
commit16213200290b7d9d09396550cae75a91b3658572 (patch)
treefd0db59ec08221621bdc278e3623ca35ea6c6089 /README.rst
parentd0376732c6ba1f86ef5bf33ad08dc19c13f8b5ce (diff)
downloadpygments-16213200290b7d9d09396550cae75a91b3658572.tar.gz
Add a README to have something to display on the bitbucket front page
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 00000000..1908db1e
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,39 @@
+README for Pygments
+===================
+
+This is the source of Pygments. It is a generic syntax highlighter for general use
+in all kinds of software such as forum systems, wikis or other applications that
+need to prettify source code.
+
+Installing
+----------
+
+... works as usual, use ``python setup.py install``.
+
+Documentation
+-------------
+
+... can be found online at http://pygments.org/ or created by ::
+
+ cd doc
+ make html
+
+Development
+-----------
+
+... takes place on `Bitbucket
+<https://bitbucket.org/birkenfeld/pygments-main>`_, where the Mercurial
+repository, tickets and pull requests can be viewed.
+
+Continuous testing runs on drone.io:
+
+.. image:: https://drone.io/bitbucket.org/birkenfeld/pygments-main/status.png
+ :target: https://drone.io/bitbucket.org/birkenfeld/pygments-main/
+
+The authors
+-----------
+
+Pygments is maintained by **Georg Brandl**, e-mail address *georg*\ *@*\ *python.org*.
+
+Many lexers and fixes have been contributed by **Armin Ronacher**, the rest of
+the `Pocoo <http://dev.pocoo.org/>`_ team and **Tim Hatch**.