diff options
author | Georg Brandl <georg@python.org> | 2019-11-24 17:52:56 +0100 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2019-11-24 17:52:56 +0100 |
commit | 3caa0eef76f0974658ec88d3fc4f6e202ce76345 (patch) | |
tree | 4998b2e22af558bdc139e6c4eecc7c919d66af2b | |
parent | f9eb5d8dda366e22684019a696272db475d4c3d0 (diff) | |
download | pygments-git-3caa0eef76f0974658ec88d3fc4f6e202ce76345.tar.gz |
Small readme overhauls
-rw-r--r-- | README.rst | 22 |
1 files changed, 13 insertions, 9 deletions
@@ -1,19 +1,20 @@ -README for Pygments +Welcome to Pygments =================== -This is the source of Pygments. It is a generic syntax highlighter that -supports over 300 languages and text formats, for use in code hosting, forums, -wikis or other applications that need to prettify source code. +This is the source of Pygments. It is a **generic syntax highlighter** written +in Python that supports over 300 languages and text formats, for use in code +hosting, forums, wikis or other applications that need to prettify source code. Installing ---------- -... works as usual, use ``python setup.py install``. +... works as usual, use ``pip install Pygments`` to get published versions, +or ``python setup.py install`` to install from a checkout. Documentation ------------- -... can be found online at http://pygments.org/ or created by :: +... can be found online at http://pygments.org/ or created with Sphinx by :: cd doc make html @@ -21,9 +22,8 @@ Documentation Development ----------- -... takes place on `GitHub -<https://github.com/pygments/pygments>`_, where the Git -repository, tickets and pull requests can be viewed. +... takes place on `GitHub <https://github.com/pygments/pygments>`_, where the +Git repository, tickets and pull requests can be viewed. Continuous testing runs on GitHub workflows: @@ -38,3 +38,7 @@ and **Matthäus Chajdas**. Many lexers and fixes have been contributed by **Armin Ronacher**, the rest of the `Pocoo <http://dev.pocoo.org/>`_ team and **Tim Hatch**. + +The code is distributed under the BSD 2-clause license. Contributors making pull +requests must agree that they are able and willing to put their contributions +under that license. |