diff options
Diffstat (limited to 'json4cpp/docs/docset/README.md')
| -rw-r--r-- | json4cpp/docs/docset/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/json4cpp/docs/docset/README.md b/json4cpp/docs/docset/README.md new file mode 100644 index 0000000000..79a778eb8f --- /dev/null +++ b/json4cpp/docs/docset/README.md @@ -0,0 +1,19 @@ +# docset + +The folder contains the required files to create a [docset](https://kapeli.com/docsets) which can be used in +documentation browsers like [Dash](https://kapeli.com/dash), [Velocity](https://velocity.silverlakesoftware.com), or +[Zeal](https://zealdocs.org). + +The docset can be created with + +```sh +make nlohmann_json.docset +``` + +The generated folder `nlohmann_json.docset` can then be opened in the documentation browser. + +A recent version is also part of the [Dash user contributions](https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/JSON_for_Modern_C%2B%2B). + +## Licenses + +The [JSON logo](https://commons.wikimedia.org/wiki/File:JSON_vector_logo.svg) is public domain. |