Fix markdown files

Author: Flamefire

README.md

@@ -6,7 +6,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
 
 # libsiedler2 - Library for reading and writing 'The Settlers II' file formats
 
-### Current Build Info
+## Current Build Info
 
 - Github Actions: ![Unit tests](https://github.com/Return-To-The-Roots/libsiedler2/workflows/Unit%20tests/badge.svg)
 
@@ -16,62 +16,80 @@ SPDX-License-Identifier: GPL-2.0-or-later
 [![Coveralls Status](https://coveralls.io/repos/github/Return-To-The-Roots/libsiedler2/badge.svg?branch=master)](https://coveralls.io/github/Return-To-The-Roots/libsiedler2?branch=master)
 [![Codecov Status](https://codecov.io/gh/Return-To-The-Roots/libsiedler2/branch/master/graph/badge.svg)](https://codecov.io/gh/Return-To-The-Roots/libsiedler2)
 
+## Prerequisites
 
-### Prerequisites:
-
-- boost ( http://www.boost.org )
+- boost ( <http://www.boost.org> )
 - libutil
 - libendian
 
-### Installation:
+## Installation
 
-```
+```bash
 mkdir build && cd build
 cmake ..
 make install
 ```
 
-To run all tests (`make test`) you need to put the original Settlers II folders (DATA and GFX) in the testFiles directory.
+To run all tests (`make test`) you need to put the original Settlers II folders
+(DATA and GFX) in the testFiles directory.
 
-### Texture format
+## Texture format
 
 The bitmaps can be stored in memory in ARGB or paletted format.
 
-The ARGB format is byte BGRA, so 4 bytes define 1 pixel with blue first and alpha last.
+The ARGB format is byte BGRA, so 4 bytes define 1 pixel with blue first
+and alpha last.
 
-If this is interpreted as a 32bit word on a little endian machine than it is (word) ARGB format.
+If this is interpreted as a 32bit word on a little endian machine than it is
+(word) ARGB format.
 That is the alpha value is the most significant byte.
 
 The used format can be set with `setTextureFormat`.
 
-All bitmaps loaded **after** this call will be in the given format with conversion beeing used if required.   
+All bitmaps loaded **after** this call will be in the given format with
+conversion beeing used if required.
 
-*Note:* While it is possible to convert paletted -> ARGB in all cases the reverse is not always possible.
+*Note:* While it is possible to convert paletted -> ARGB in all cases the
+reverse is not always possible.
 So using a paletted format may result in failure while loading ARGB bitmaps.
 
-### Palettes
+## Palettes
 
-As some files may contain embedded palettes (i.e LBM files): Be careful when reading, writing or using them.
+As some files may contain embedded palettes (i.e LBM files):
+Be careful when reading, writing or using them.
 
 - If the bitmap is paletted, the loaded result contains a palette.
-- If it is ARGB, it may contain a palette and this palette may be invalid (not contain all colors) which can result in errors when converting to paletted.
+- If it is ARGB, it may contain a palette and this palette may be invalid
+(not contain all colors) which can result in errors when converting to paletted.
 
-Use `checkPalette` to make sure the palette is valid. (Trivially true for paletted bitmaps.)
+Use `checkPalette` to make sure the palette is valid.
+(Trivially true for paletted bitmaps.)
 
 For the usage the following applies:
 
-1. No palette is required or used when no conversion occurs (Read/Write, Create/Print to from file/buffer with same format)
-2. Loading: If the file contains a palette, it is stored in the bitmap and used.   
-            If the file does not contain a palette the passed palette is used, but only stored with the bitmap if it is paletted.
-3. Writing: If the file format contains a palette and the bitmap contains one, it is used instead of the passed palette.
-            Otherwise the palette passed is used with the bitmaps palette as a fallback.
-            It is an error not to pass a palette when conversion is required unless the bitmap contains one.   
-            If the file format supports paletted and unpalleted images then the paletted format is used, if (and only if) the bitmap is paletted or contains a palette.
-4. Drawing: The `print` function will prefer the passed palette for conversion from ARGB and the contained palette for conversion to ARGB.
-5. Creating: The `create` function resets the bitmap completely (size, palette, format, data).
+1. No palette is required or used when no conversion occurs
+(Read/Write, Create/Print to from file/buffer with same format)
+2. Loading: If the file contains a palette,
+            it is stored in the bitmap and used.  
+            If the file does not contain a palette the passed palette is used,
+            but only stored with the bitmap if it is paletted.
+3. Writing: If the file format contains a palette and the bitmap contains one,
+            it is used instead of the passed palette.
+            Otherwise the palette passed is used with the bitmaps palette as
+            a fallback.
+            It is an error not to pass a palette when conversion is required
+            unless the bitmap contains one.  
+            If the file format supports paletted and unpalleted images then the
+            paletted format is used, if (and only if) the bitmap is paletted
+            or contains a palette.
+4. Drawing: The `print` function will prefer the passed palette for conversion
+            from ARGB and the contained palette for conversion to ARGB.
+5. Creating: The `create` function resets the bitmap completely
+            (size, palette, format, data).
              It will create a bitmap with the same format as the buffer.
              A palette is required and stored for paletted formats.
-             
-### Additional information
 
-A detailed description of the file formats are here: https://www.siedler25.org/formate/ (in German)
+## Additional information
+
+A detailed description of the file formats are here:
+<https://www.siedler25.org/formate> (in German)

examples/README.md

@@ -7,18 +7,28 @@ SPDX-License-Identifier: GPL-2.0-or-later
 # RTTR Utilities for The Settlers 2
 
 ## LstPacker
+
 Packs and unpacks file archives from The Settlers 2.
-This is mostly meant for use with LST files, which are simple collections of (mainly) images.
-But it also works for other archive-like files, like Font-, Sound- and Palette-Files.
+This is mostly meant for use with LST files, which are simple collections of
+(mainly) images.
+But it also works for other archive-like files, like Font-, Sound- and
+Palette-Files.
 
-See `lstpacker --help` for details on usage but mostly it is `lstpacker <foo.lst>` for unpacking and `lstpacker <foo>` for packing a folder into a lst file.
+See `lstpacker --help` for details on usage
+but mostly it is `lstpacker <foo.lst>` for unpacking
+and `lstpacker <foo>` for packing a folder into a lst file.
 
 ## ChTransparentIdx
-The image files have a special palette index that is used as the transparent color.
+
+The image files have a special palette index that is used as
+the transparent color.
 With this tool you can change the index to another index.
 
-Use `chTransparentIdx --from <254> --to <255> <foo.lst>` to change all images in that lst file.
+Use `chTransparentIdx --from <254> --to <255> <foo.lst>` to change
+all images in that lst file.
 
 ## Outline
-This is an internal helper tool to extract the fonts from the `RESOURCE.DAT` file and convert it into a font file usable by RTTR.
+
+This is an internal helper tool to extract the fonts from the `RESOURCE.DAT`
+file and convert it into a font file usable by RTTR.
 Is is only kept for reference and no longer actually used.