mari/minipp
1
0
Fork 0
mirror of https://github.com/mariiaan/minipp.git synced 2026-05-14 10:11:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix links

Browse Source
This commit is contained in:
Marian Wölpper
2025-02-01 20:42:56 +01:00
committed by GitHub
parent 3b7c317f57
commit 27b720245c
1 changed files with 2 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -15,17 +15,6 @@ minipp provides a convenient way to parse and write configuration files in the "
- **Single Header**: minipp is a single-header library, meaning you only need to include one file. - **Single Header**: minipp is a single-header library, meaning you only need to include one file.
## Usage
To use minipp in your project:
```cpp
#define MINIPP_IMPLEMENTATION
#include "minipp.hpp"
```
Then, you can use `minipp::MiniPPFile` to parse and write mini files throughout your code.
### Example Usage ### Example Usage
```cpp ```cpp
@@ -132,11 +121,11 @@ int main()
## Example ## Example
An example mini file is contained in this [repository](test.mini). The full mini file format specilization can be found [here](https://github.com/ToyB-Chan/mini-file-format). An example mini file is contained in this [repository](minipp/test.mini). The full mini file format specilization can be found [here](https://github.com/ToyB-Chan/mini-file-format).
## Installation ## Installation
1. Copy the contents of "minipp.hpp" to a new file in your project. 1. Copy the contents of [minipp.hpp](minipp/minipp.hpp) to a new file in your project.
2. #Include "minipp.hpp" after defining MINIPP_IMPLEMENTATION in one single cpp file. 2. #Include "minipp.hpp" after defining MINIPP_IMPLEMENTATION in one single cpp file.
3. #Include "minipp.hpp" in any other desired files without the IMPLEMENTATION define! 3. #Include "minipp.hpp" in any other desired files without the IMPLEMENTATION define!