Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Doxygen build is now working and publishing
  • Loading branch information
brofield authored Dec 9, 2024
1 parent be43c67 commit 6048871
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
simpleini
=========

![Test Results Linux](https://github.com/brofield/simpleini/actions/workflows/test.yml/badge.svg)

![Latest Test Results](https://github.com/brofield/simpleini/actions/workflows/build-and-test.yml/badge.svg)
A cross-platform library that provides a simple API to read and write INI-style configuration files. It supports data files in ASCII, MBCS and Unicode. It is designed explicitly to be portable to any platform and has been tested on Windows, WinCE and Linux. Released as open-source and free using the MIT licence.

[Full documentation](https://brofield.github.io/simpleini/)

# Feature Summary

- MIT Licence allows free use in all software (including GPL and commercial)
Expand All @@ -21,6 +23,7 @@ A cross-platform library that provides a simple API to read and write INI-style
- preserves comments on the file, section and keys where possible
- supports both char or wchar_t programming interfaces
- supports both MBCS (system locale) and UTF-8 file encodings
- supports ICU as conversion library on all platforms
- system locale does not need to be UTF-8 on Linux/Unix to load UTF-8 file
- support for non-ASCII characters in section, keys, values and comments
- support for non-standard character types or file encodings via user-written converter classes
Expand All @@ -29,7 +32,7 @@ A cross-platform library that provides a simple API to read and write INI-style

# Documentation

Full documentation of the interface is available in doxygen format.
Full documentation of the interface is available in doxygen format. See [latest documentation here](https://brofield.github.io/simpleini/).

# Examples

Expand Down

0 comments on commit 6048871

Please sign in to comment.