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 07:17:54 +01:00
committed by GitHub
parent c048aba8a5
commit 5526eb18a6
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -13,10 +13,10 @@ Ends with `.mini` i.e. `config.mini`.
- Keys within (sub-) sections use `key = value` syntax. - Keys within (sub-) sections use `key = value` syntax.
- 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 outside of strings are ignored. - Spaces are ignored as long as they don't split up names or values.
- Empty lines are ignored - Empty lines are ignored
- Comments are denoted by `#` and may only appear on separate lines. - Comments are denoted by `#` and may only appear on separate lines.
- Cases are sensitive except where otherwise noted. - Cases are sensitive, except where otherwise noted.
## Supported Data Types ## Supported Data Types
@@ -24,9 +24,9 @@ The format supports the following data types:
### Integer ### Integer
- Defined as a sequence of digits (`0-9`). - Defined as a sequence of digits (`0-9`).
- Can be suffixed with `x` to be interpreted as hexadecimal (`0-9`, `a-f`, `A-F`). - May be suffixed with `x` to be interpreted as hexadecimal (`0-9`, `a-f`, `A-F`).
- Can be suffixed with `b` to be interpreted as binary (`0-1`). - May be suffixed with `b` to be interpreted as binary (`0-1`).
- Can contain underscores (`_`) for better readability. - May contain underscores (`_`) for better readability.
- Example: `value = 5` - Example: `value = 5`
- Example: `hexValue = FA8x` - Example: `hexValue = FA8x`
- Example: `binValue = 0010010b` - Example: `binValue = 0010010b`
@@ -40,7 +40,7 @@ The format supports the following data types:
- `\n` for a newline - `\n` for a newline
- `\t` for a tab - `\t` for a tab
- `\\` for a backslash - `\\` for a backslash
- Strings can be empty. - Strings may be empty.
- Example: `string = "My string` - Example: `string = "My string`
- Example: `string = "Line 1\nLine 2"` - Example: `string = "Line 1\nLine 2"`
- Example: `string = "Tab\tSeparated"` - Example: `string = "Tab\tSeparated"`
@@ -49,11 +49,11 @@ The format supports the following data types:
- Example: `emptyString = ""` - Example: `emptyString = ""`
### Array ### Array
- Arrays are enclosed in square brackets (`[]`) and contain comma-separated values. - Arrays are enclosed in square brackets (`[]`) and contain comma-separated values. A space may follow after a comma.
- Arrays may only contain one datatype at a time. - Arrays may only contain one datatype at a time.
- Arrays may be of any positive dimension. - Arrays may be of any positive dimension.
- Arrays may be of any positive length. - Arrays may be of any positive length.
- Arrays can be empty. - Arrays may be empty.
- Example: `array = [5, 6, 10]` - Example: `array = [5, 6, 10]`
- Example: `array2d = [[5, 8], [9, 7], [23, 47]]` - Example: `array2d = [[5, 8], [9, 7], [23, 47]]`
- Example: `array2d = [[9], [50, 3], [54, 12, 46, 37]]` - Example: `array2d = [[9], [50, 3], [54, 12, 46, 37]]`