aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-05-23 17:04:44 -0700
committerFuwn <[email protected]>2021-05-23 17:04:44 -0700
commit16c8dbadae907b94ac02d19fb3e64d22eef4b8e3 (patch)
treea3ea11a29bbb4de4fc682ca4a5c50f1d75ce7e31 /README.rst
parentdocs(global): spelling corrections, global docs (diff)
downloadwhirl-16c8dbadae907b94ac02d19fb3e64d22eef4b8e3.tar.xz
whirl-16c8dbadae907b94ac02d19fb3e64d22eef4b8e3.zip
docs(readme): expand documentation section
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 7c91e39..263146c 100644
--- a/README.rst
+++ b/README.rst
@@ -58,7 +58,12 @@ blog).
Documentation
-------------
-https://whirlsplash.org/docs/
+Documentation about the entire Whirlsplash ecosystem can be found
+`here <https://whirlsplash.org/docs/>`_.
+
+If you are looking for explicit documentation of only Whirl's source code, you
+must generate them yourself be cloning the repository and running the Cargo
+subcommand: `cargo +nightly doc --open --document-private-items --no-deps`.
Known Issues
------------