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

Update README.md

Browse Source
This commit is contained in:
Marian Wölpper
2025-02-02 20:51:45 +01:00
committed by GitHub
parent 3f96d049e5
commit 04dcc77db6
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -43,7 +43,7 @@ int main()
MiniPPFile::Values::IntValue* yearValue = nullptr; MiniPPFile::Values::IntValue* yearValue = nullptr;
result = gameSection->GetValue("year", &yearValue); result = gameSection->GetValue("year", &yearValue);
// Get a sub-section (section of a section (stated in the MINI file with "[game.window]") // Get a sub-section (section of a section, stated in the MINI file with "[game.window]")
MiniPPFile::Section* windowSection = nullptr; MiniPPFile::Section* windowSection = nullptr;
result = gameSection->GetSubSection("window", &windowSection); result = gameSection->GetSubSection("window", &windowSection);
@@ -92,9 +92,12 @@ int main()
// Access values // Access values
MiniPPFile::Values::StringValue* nameValue = nullptr; MiniPPFile::Values::StringValue* nameValue = nullptr;
result = gameSection->GetValue("name", &nameValue); result = gameSection->GetValue("name", &nameValue);
// .. OR ..
std::string nameValue = gameSection->GetValueOrDefault<MiniPPFile::Values::StringValue>("name", "Unknown");
// Navigate nested sections // Navigate nested sections
MiniPPFile::Section* windowSection = nullptr; MiniPPFile::Section* windowSection = nullptr;
result = gameSection->GetSubSection("window", &windowSection); result = gameSection->GetSubSection("window", &windowSection);
@@ -110,11 +113,11 @@ int main()
```cpp ```cpp
// Handle arrays // Handle arrays
MiniPPFile::Values::ArrayValue* pointsValue = nullptr; MiniPPFile::Values::ArrayValue* platformsValue = nullptr;
result = root.GetValue("game.window.platform.points", &pointsValue); result = root.GetValue("game.window.platform.points", &platformsValue);
// Modify the array values (or read them) // Modify the array values (or read them)
pointsValue->GetValues().push_back(std::make_unique<MiniPPFile::Values::StringValue>("haiku")); platformsValue->GetValue().push_back(std::make_unique<MiniPPFile::Values::StringValue>("haiku"));
``` ```
5. **Write new files**: 5. **Write new files**:
@@ -125,7 +128,7 @@ int main()
## Example ## Example
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). An example mini file is contained in this [repository](minipp/test.mini). The full mini file format specification can be found [here](https://github.com/ToyB-Chan/mini-file-format).
## Installation ## Installation