From a125b38f2c5e901bff0d18a9a6dabe5209b10e8e Mon Sep 17 00:00:00 2001 From: Mike Bierlee Date: Sun, 9 Oct 2022 01:06:52 +0300 Subject: [PATCH] Add additional readme sections --- README.md | 12 ++++++++++++ dub.json | 1 + 2 files changed, 13 insertions(+) diff --git a/README.md b/README.md index 311861f..a9e6541 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,18 @@ The following file formats are currently supported: \*\* _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._ \*\*\* _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 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. \ No newline at end of file diff --git a/dub.json b/dub.json index 9eace40..8430a53 100644 --- a/dub.json +++ b/dub.json @@ -4,6 +4,7 @@ "copyright": "Copyright © 2022, Mike Bierlee", "authors": ["Mike Bierlee"], "license": "MIT", + "-ddoxTool": "scod", "configurations": [ { "name": "library",