jeremy/initial
1
Fork 0
Code Releases Activity

improve readme contents

Browse source
This commit is contained in:
Jeremy Baxter 2024-06-05 12:30:01 +12:00
parent 588324659b
commit 756d1a42ee
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,4 +1,4 @@
## initial - INI parsing library for the D programming language
## initial - INI parser for the D programming language
My attempt at making a sane and high-quality INI parsing library for D.
@ -7,9 +7,9 @@ My attempt at making a sane and high-quality INI parsing library for D.
key = value
```
An INI file's contents is stored in an `INIUnit` structure. This contains
multiple `INISection`s stored in an associative array that you can read
or set yourself.
The contents of an INI file is stored in an `INIUnit` structure. This
contains an associative array of `INISection`s that you can read or set
yourself.
initial also provides serialisation facilities that can turn `INIUnit`s
and `INISection`s back into an INI document. Handy for if your program
@ -44,13 +44,13 @@ write("config.ini", ini.serialise());
## Usage
Download initial.d and put it somewhere in your import path, then compile it alongside
Copy initial.d to somewhere in your import path, then compile it alongside
your program and link it in. Or you can do it all at once by using -i.
```
dmd program.d initial.d
dmd -i program.d
```
dmd program.d initial.d
dmd -i program.d
Documentation can be found by reading the documentation comments in the code.
## Progress