toybchan/mini-file-format
1
1
Fork 0
mirror of https://github.com/ToyB-Chan/mini-file-format.git synced 2026-05-14 10:21:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
toybchan
2025-01-31 16:52:15 +01:00
committed by GitHub
parent 6b1abd1ae0
commit 686e0c561c
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -11,6 +11,7 @@ Ends with `.mini` i.e. `config.mini`.
- All (sub-) sections may only be defined once. - All (sub-) sections may only be defined once.
- (Sub-) sections can be empty. - (Sub-) sections can be empty.
- Keys within (sub-) sections use `key = value` syntax. - Keys within (sub-) sections use `key = value` syntax.
- Values may never reach over multiple lines.
- Key and (sub-) section names may only contain `a-z`, `A-Z`, `0-9`, and `_`. - Key and (sub-) section names may only contain `a-z`, `A-Z`, `0-9`, and `_`.
- Empty keys (i.e., keys without values) are not allowed. - Empty keys (i.e., keys without values) are not allowed.
- Spaces are ignored as long as they don't split up names or values. - Spaces are ignored as long as they don't split up names or values.
@@ -107,6 +108,12 @@ myArray2 = [[5, 6], 1] | Technically same as above, dimensions must match
myString = 'Hello' | Strings may only be encapsulated by ". myString = 'Hello' | Strings may only be encapsulated by ".
my-value = 5 | Invalid character in key. my-value = 5 | Invalid character in key.
[MyOtherSection.Subsection] | "MyOtherSection" is not defined. [MyOtherSection.Subsection] | "MyOtherSection" has not been defined before.
myValue = 16 # a comment | Inline comments are not allowed. myValue = 16 # a comment | Inline comments are not allowed.
[MyOtherSection]
myArray = [ | Values may not span over multiple lines.
[5, 7],
[9. 2]
]
``` ```