diff README.rst @ 120:ef68b3769be5

Convert/rename README.md to README.rst and enhance it considerably
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 06 May 2026 15:28:25 +0200
parents README.md@5812e7f3bc13
children c90be4a80c1a
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Wed May 06 15:28:25 2026 +0200
@@ -0,0 +1,82 @@
+.. -*- coding: utf-8 -*-
+
+*****************************************
+ README -- Pseudocode Lexer for Pygments
+*****************************************
+
+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:
+
+.. list-table::
+   :align: left
+   :header-rows: 1
+
+   * - Name
+     - Description
+     - Extension(s)
+     - Aliases / Short Name(s)
+
+   * - AlgPseudocode
+     - Pseudocode with inspirations from CTAN's "Algpseudocodex"
+     - \*.algpseudocode, \*.algpseudo
+     - algpseudocode, algpseudo
+
+   * - AlgPseudocodeFR
+     - AlgPseudocode with french keyword expansion
+     - \*.algpseudo-fr, \*.algpseudocode-fr
+     - algpseudocode-fr, algpseudo-fr
+
+   * - AlgPseudocodeDE
+     - AlgPseudocode with german keyword expansion
+     - \*.algpseudo-de, \*.algpseudocode-de
+     - algpseudocode-de, algpseudo-de
+
+   * - FrPseudocode
+     - The original lexer (slightly changed) from `pygments-lexer-pseudocode`
+     - \*.fr-algo, \*.fr-pseudocode
+     - fr-pseudocode, fr-pseudo, fr-algorithm, fr-algo
+
+
+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 Pseudocode lexer is licensed under the terms of the MIT licence