From 3b68fac66fda9a96d79e83434fe7e4384c15504c Mon Sep 17 00:00:00 2001 From: Shon Feder Date: Tue, 5 Nov 2019 15:08:38 -0500 Subject: [PATCH] Note how to find the docs in the readme --- README.cpp.md | 9 +++++++++ README.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/README.cpp.md b/README.cpp.md index 5ea2c040..e8084960 100644 --- a/README.cpp.md +++ b/README.cpp.md @@ -35,6 +35,15 @@ $ opam pin add opium_kernel --dev-repo $ opam pin add opium --dev-repo ``` +## Documentation + +- Read [the hosted documentation for the latest version][hosted-docs]. +- Build and view the docs for version installed locally using [`odig`][odig]: + `odig doc opium`. + +[hosted-docs]: https://rgrinberg.github.io/opium/ +[odig]: https://github.com/b0-system/odig + ## Examples All examples are built once the necessary dependencies are installed. diff --git a/README.md b/README.md index 6b93633e..35e82c32 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,15 @@ $ opam pin add opium_kernel --dev-repo $ opam pin add opium --dev-repo ``` +## Documentation + +- Read [the hosted documentation for the latest version][hosted-docs]. +- Build and view the docs for version installed locally using [`odig`][odig]: + `odig doc opium`. + +[hosted-docs]: https://rgrinberg.github.io/opium/ +[odig]: https://github.com/b0-system/odig + ## Examples All examples are built once the necessary dependencies are installed.