dub-mirrors/mirage-config
1
0
Fork 0
mirror of https://github.com/mbierlee/mirage-config.git synced 2024-11-15 04:44:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add additional readme sections

Browse source
This commit is contained in:
Mike Bierlee 2022-10-09 01:06:52 +03:00
parent 4e029a7408
commit a125b38f2c
2 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -67,6 +67,18 @@ The following file formats are currently supported:
<sup>\*\*</sup> _Loads files based on their extension. If the file does not use one of the extensions in the table, you must use a specific loader._ <sup>\*\*</sup> _Loads files based on their extension. If the file does not use one of the extensions in the table, you must use a specific loader._
<sup>\*\*\*</sup> _Besides parsing strings like the other formats, it also accepts a `JSONValue`._ <sup>\*\*\*</sup> _Besides parsing strings like the other formats, it also accepts a `JSONValue`._
Documentation
-------------
You can generate documentation from the source code using DUB:
```
dub build --build=ddox
```
The documentation can then be found in docs/
## History ## History
For a full overview of changes, see [CHANGES.md](CHANGES.md) For a full overview of changes, see [CHANGES.md](CHANGES.md)
## Contributing
Any and all pull requests are welcome! If you (only) want discuss changes before making them, feel free to open an Issue on github. Please develop your changes on (a branch based on) the develop branch. Continuous integration is preferred so feature branches are not neccessary.

1
dub.json
View file

@ -4,6 +4,7 @@
"copyright": "Copyright © 2022, Mike Bierlee", "copyright": "Copyright © 2022, Mike Bierlee",
"authors": ["Mike Bierlee"], "authors": ["Mike Bierlee"],
"license": "MIT", "license": "MIT",
"-ddoxTool": "scod",
"configurations": [ "configurations": [
{ {
"name": "library", "name": "library",