.. -*- coding: utf-8 -*-

*****************************************
 README -- Pseudocode Lexer for Pygments
*****************************************

:Version: 3.0.0.dev1
:Date: |VCSJustDate|
:Revision: |VCSRevision|
:License: MIT License

This package contains `Pygments`_ lexers for some basic pseudocode.

Initially a fork of `pygments-lexer-pseudocode` it has been considerably
changed and expanded.

It now contains the following lexers:

.. include:: lexerlist.rst

It additionally contains the following filters:

.. include:: filterlist.rst


Installation
============

The lexers are available as a `Python`_ wheel package::

    pip install pygments-lexer-pseudocode2

Alternatively, to build from the source code repository::

    python -m build


Usage
=====

After installation the Pseudocode lexers automatically register itself
within the plugin system of Pygments. All aliases and filename extensions
from above are made known to Pygments.

Usage is easy.

  Pygmentizing a file with a known file extension::

    pygmentize document.algpseudocode

  Or you can manally select the Pseudocode lexer you want to use by
  using a command line flag::

    pygmentize -l algpseudocode somefile

  Within `Sphinx`_ use a lexer like this::

    .. code-block:: algpseudocode


License
=======

The package is licensed under the terms of the MIT Licence.

Some code snippets are licensed under the terms of the
BSD 2-Clause "Simplified" License as they are taken from the Python
lexer that is included in `Pygments`_.