Update README

- strict line breaks
- no ansi, no C89
- new build and run instructions

Author: lmoellendorf

README.md

@@ -10,52 +10,101 @@ Go there for:
 - [Merge Requests](https://gitlab.com/iniparser/iniparser/-/merge_requests/new)
 
 Changes in March 2024:
-@lmoellendorf is taking over maintenance for this project. The objective is to get all known issues fixed and released as v4.2.
-After that, this project will be frozen here as v4.2 and development should continue as v5, probably on gitlab. Pointers will be updated then.
+@lmoellendorf is taking over maintenance for this project. The objective is to
+get all known issues fixed and released as v4.2.  After that, this project will
+be frozen here as v4.2 and development should continue as v5, probably on
+gitlab. Pointers will be updated then.
 
-Thanks a million times to Lars for his tremendous work and help in keeping this library alive!
+Thanks a million times to Lars for his tremendous work and help in keeping this
+library alive!
 
-Many thanks to @touilleman for his exceptional contributions and efforts for maintaining this project for a decade. Manu, you rock!
+Many thanks to @touilleman for his exceptional contributions and efforts for
+maintaining this project for a decade. Manu, you rock!
 
 ## I - Overview
 
 This modules offers parsing of ini files from C.
-See the [complete documentation](https://iniparser.gitlab.io/iniparser-meta/) in HTML format.
+See the [complete documentation](https://iniparser.gitlab.io/iniparser-meta/)
+in HTML format.
 
 
 Key features:
 
  - Small : around 1500 sloc inside 4 files (2 .c and 2 .h)
- - Portable : no dependancies, written in `-ansi -pedantic` C89
+ - Portable : no dependancies, written in `-pedantic` C
  - Fully re-entrant : easy to make it thread-safe (just surround
    library calls by mutex)
 
 ## II - Building project
 
-A simple `make` at the root of the project should be enough to get the static
-(i.e. `libiniparser.a`) and shared (i.e. `libiniparser.so.0`) libraries compiled.
+This project uses CMake as build system. Use these command at the root or the
+project to get the static (i.e. `libiniparser.a`) and shared (i.e.
+`libiniparser.so`) libraries compiled:
 
-You should consider trying the following rules too :
+```
+mkdir build
+cd build
+cmake ..
+make all
+```
 
+There are some CMake option which are `OFF` by default:
 
- - `make check` : run unit tests
- - `make example` : compile the example, run it with `./example/iniexample`
- - `make docs` : generate the documentation, open the file `html/index.html` with any HTML-capable browser.
+- `BUILD_TESTS`
+- `BUILD_EXAMPLES`
 
-For installation and packaging see [iniparser-meta](https://gitlab.com/iniparser/iniparser-meta).
+From within build directory execute `ccmake ..` to see all.
 
-## III - License
+## III - Tests
+
+```
+mkdir build
+cd build
+cmake -DBUILD_TESTS ..
+make all
+```
+
+While still in the build project you can run the tests by calling `ctest`.
+Test output can be found in build directory under
+`Testing/Temporary/LastTest.log`.
+
+## IV - Examples
+
+To build the examples:
+
+```
+mkdir build
+cd build
+cmake -DBUILD_EXAMPLES ..
+make all
+```
+
+From the build directory run the examples with:
+
+ - `./iniexample`
+ - `./iniwrite`
+ - `./parse ../example/twisted.ini`
+
+## V - Documentation
+
+Documentation is build by default and can be found in build directory under
+`html`.
+
+Open the file `html/index.html` with any HTML-capable browser.
+
+## VI - License
 
 This software is released under MIT License.
 See LICENSE for more details
 
-## IV - Versions
+## VII - Versions
 
-Current version is 4.2. Version 4.0 introduces breaking changes in the api.
+Current version is 4.2.x. Version 4.0 introduces breaking changes in the api.
 Older versions 3.1 and 3.2 with the legacy api are available as tags.
 
-## V - FAQ
+## VIII - FAQ
 
-See [FAQ-en.md](FAQ-en.md) in this directory for answers to Frequently Asked Questions.
+See [FAQ-en.md](FAQ-en.md) in this directory for answers to Frequently Asked
+Questions.
 
 还有简化中国翻译在[FAQ-zhcn.md](FAQ-zhcn.md).