diff options
Diffstat (limited to 'iniparser-4.1/README.md')
| -rw-r--r-- | iniparser-4.1/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/iniparser-4.1/README.md b/iniparser-4.1/README.md new file mode 100644 index 0000000..dbc30d0 --- /dev/null +++ b/iniparser-4.1/README.md @@ -0,0 +1,44 @@ +[](https://travis-ci.org/ndevilla/iniparser) + +# Iniparser 4 # + + +## I - Overview + +This modules offers parsing of ini files from the C level. +See a complete documentation in HTML format, from this directory +open the file html/index.html with any HTML-capable browser. + +Key features : + + - Small : around 1500 sloc inside 4 files (2 .c and 2 .h) + - Portable : no dependancies, written in `-ansi -pedantic` C89 + - Fully reintrant : 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. + +You should consider trying the following rules too : + + - `make check` : run the unitary tests + - `make example` : compile the example, run it with `./example/iniexample` + +## III - License + +This software is released under MIT License. +See LICENSE for full informations + +## IV - Versions + +Current version is 4.1. 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 + +See [FAQ-en.md](FAQ-en.md) in this directory for answers to Frequently Asked Questions. + +还有简化中国翻译在[FAQ-zhcn.md](FAQ-zhcn.md). |