diff README.rst @ 272:9afbc584a444

Semantic markup and style in the README
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 19 May 2026 23:21:43 +0200
parents a350b921b9bd
children 69a5868b30fd
line wrap: on
line diff
--- a/README.rst	Tue May 19 23:13:44 2026 +0200
+++ b/README.rst	Tue May 19 23:21:43 2026 +0200
@@ -32,13 +32,17 @@
 Installation
 ============
 
-The lexers are available as a `Python`_ wheel package::
+The lexers are available as a `Python`_ wheel package:
 
-    pip install pygments-lexer-pseudocode2
+  .. code-block:: shell
+
+     pip install pygments-lexer-pseudocode2
 
-Alternatively, to build from the source code repository::
+Alternatively, to build from the source code repository:
 
-    python -m build
+  .. code-block:: shell
+
+     python -m build
 
 
 Usage
@@ -50,18 +54,24 @@
 
 Usage is easy:
 
-  Pygmentizing a file with a known file extension::
+  Pygmentizing a file with a known file extension:
 
-    pygmentize document.algpseudocode
+    .. code-block:: shell
+
+       pygmentize document.algpseudocode
 
   Or you can manually select the Pseudocode lexer you want to use by
-  using a command line flag::
+  using a command line flag:
 
-    pygmentize -l algpseudocode somefile
+    .. code-block:: shell
+
+       pygmentize -l algpseudocode somefile
 
-  Within `Sphinx`_ use a lexer like this::
+  Within `Sphinx`_ use a lexer like this:
 
-    .. code-block:: algpseudocode
+    .. code-block:: none
+
+       .. code-block:: algpseudocode
 
 
 Licenses