[latex3-commits] [git/LaTeX3-latex3-xcolor] main: improve markup of readme (1b72736)

[Ulrike Fischer]

Repository : https://github.com/latex3/xcolor
On branch  : main
Link       : https://github.com/latex3/xcolor/commit/1b727362cb0c9d547e98479ef110a924595ee9a2

>---------------------------------------------------------------

commit 1b727362cb0c9d547e98479ef110a924595ee9a2
Author: Ulrike Fischer <fischer at troubleshooting-tex.de>
Date:   Sun Jun 12 15:41:37 2022 +0200

    improve markup of readme


>---------------------------------------------------------------

1b727362cb0c9d547e98479ef110a924595ee9a2
 README.md | 54 +++++++++++++++++++++++++++++++++---------------------
 1 file changed, 33 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index be437e0..dd8e528 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-## Package `xcolor' by Dr. Uwe Kern
+## Package `xcolor` by Dr. Uwe Kern
 
 Version 2022-06-12 v2.14
 
 Maintained by the LaTeX Project https://github.com/latex3/xcolor/issues
 
-`xcolor' provides easy driver-independent access to several kinds of
+`xcolor` provides easy driver-independent access to several kinds of
 colors, tints, shades, tones, and mixes of arbitrary colors by means of
 color expressions like \color{red!50!green!20!blue}.
 It allows to select a document-wide target color model and offers tools
@@ -21,42 +21,54 @@ LaTeX Project Public License, version 1.3c or later.
 
 ## Installation instructions
 
-Extract all package files:
-  `latex xcolor.ins'
+* Extract all package files:
   
-Put the generated files to their respective locations
+  ~~~~
+  latex xcolor.ins
+  ~~~~
+
+* Put the generated files to their respective locations
 within the TeX installation:
+
+  ~~~~
   *.sty -> /tex/latex/xcolor/
   *.def -> /tex/latex/xcolor/
   *.pro -> /dvips/xcolor/
+  ~~~~
+
+* Create the documentation:
+
+  ~~~~ 
+  latex xcolor.dtx
+  latex xcolor.dtx
+  makeindex -s gind.ist xcolor.idx
+  latex xcolor.dtx
+  latex xcolor.dtx
+  ~~~~
   
-Create the documentation:
-  `latex xcolor.dtx'
-  `latex xcolor.dtx'
-  `makeindex -s gind.ist xcolor.idx'
-  `latex xcolor.dtx'
-  `latex xcolor.dtx'
+* Run the test files (N=1,2,...):
 
-Run the test files (N=1,2,...):
-  `latex xcolorN.tex'
-  `latex xcolorN.tex'
+  ~~~~
+  latex xcolorN.tex
+  latex xcolorN.tex
+  ~~~~
 
 ## Notes
 
-- `xcolor1.tex' should run with both LaTeX and pdfLaTeX, it yields a
+- `xcolor1.tex` should run with both LaTeX and pdfLaTeX, it yields a
   50-page document with several systematic color conversion examples
-- `xcolor2.tex' is a 3-page `pstricks' example document that won't run
+- `xcolor2.tex` is a 3-page `pstricks` example document that won't run
   with pdfLaTeX
-- `xcolor3.tex' is a 2-page example for demonstrating several display
+- `xcolor3.tex` is a 2-page example for demonstrating several display
   and logging facilities
-- `xcolor4.tex' is a 1-page driver test file;
+- `xcolor4.tex` is a 1-page driver test file;
   uncomment the relevant code line in the header and run it with the
-  appropriate program, e.g., `latex xcolor4' or any other processor;
+  appropriate program, e.g., `latex xcolor4` or any other processor;
   apply any desired post-processing like dvips, dvipdfm, etc.
-- If the file `xcolor.ins' is missing, run `latex xcolor.dtx' once
+- If the file `xcolor.ins` is missing, run `latex xcolor.dtx` once
   and quit the LaTeX compiler as soon as the first error message
   appears.
 
 ## History
 
-See file `ChangeLog'.
+See file `ChangeLog`.