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

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

:Version: 3.0.0.dev1
:Date: |VCSJustDate|
:Copyright:
   - © 2026 Franz Glasner
   - © 2015 Simon Wachter
:License: MIT License
:Revision: |VCSRevision|


This package contains `Pygments`_ lexers for some variants of 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

.. content-pdf


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

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

  .. code-block:: shell

     pip install pygments-lexer-pseudocode2

Alternatively, to build from the source code repository:

  .. code-block:: shell

     python -m build


Usage
=====

After installation all the Pseudocode lexers and filters automatically
register itself with the plugin system of Pygments.
Their respective aliases and filename extensions are made known to Pygments.

Usage is easy:

  Pygmentizing a file with a known file extension:

    .. code-block:: shell

       pygmentize document.algpseudocode

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

    .. code-block:: shell

       pygmentize -l algpseudocode somefile

  Within `Sphinx`_ use a lexer like this:

    .. code-block:: none

       .. code-block:: algpseudocode


Licenses
========

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`_.
