README.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. Welcome to Pygments
  2. ===================
  3. This is the source of Pygments. It is a **generic syntax highlighter** written
  4. in Python that supports over 300 languages and text formats, for use in code
  5. hosting, forums, wikis or other applications that need to prettify source code.
  6. Installing
  7. ----------
  8. ... works as usual, use ``pip install Pygments`` to get published versions,
  9. or ``python setup.py install`` to install from a checkout.
  10. Documentation
  11. -------------
  12. ... can be found online at http://pygments.org/ or created with Sphinx by ::
  13. cd doc
  14. make html
  15. Development
  16. -----------
  17. ... takes place on `GitHub <https://github.com/pygments/pygments>`_, where the
  18. Git repository, tickets and pull requests can be viewed.
  19. Continuous testing runs on GitHub workflows:
  20. .. image:: https://github.com/pygments/pygments/workflows/Pygments/badge.svg
  21. :target: https://github.com/pygments/pygments/actions?query=workflow%3APygments
  22. The authors
  23. -----------
  24. Pygments is maintained by **Georg Brandl**, e-mail address *georg*\ *@*\ *python.org*
  25. and **Matthäus Chajdas**.
  26. Many lexers and fixes have been contributed by **Armin Ronacher**, the rest of
  27. the `Pocoo <http://dev.pocoo.org/>`_ team and **Tim Hatch**.
  28. The code is distributed under the BSD 2-clause license. Contributors making pull
  29. requests must agree that they are able and willing to put their contributions
  30. under that license.