Note how to find the docs in the readme

rgrinberg · Dec 23, 2019 · 3b68fac · 3b68fac
1 parent b38bab2
commit 3b68fac
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git 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
@@ -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.