aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-06-07 03:04:52 -0700
committerFuwn <[email protected]>2021-06-07 03:04:52 -0700
commit52fe332b148245d985c0fcbe598584b7a3c42a96 (patch)
treee8d99820d9d5db9e0b97c66fd8cdbcbdb1697aa3 /README.rst
parentfix(readme): escape asterices (diff)
downloadwhirl-52fe332b148245d985c0fcbe598584b7a3c42a96.tar.xz
whirl-52fe332b148245d985c0fcbe598584b7a3c42a96.zip
fix(readme): move code-block to seperate block
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 5c679ae..e205709 100644
--- a/README.rst
+++ b/README.rst
@@ -63,7 +63,11 @@ Documentation about the entire Whirlsplash ecosystem can be found
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: :code:`cargo +nightly doc --open --document-private-items --no-deps`.
+subcommand;
+
+.. code-block:: shell
+
+ $ cargo +nightly doc --open --document-private-items --no-deps
Known Issues
------------
@@ -92,8 +96,8 @@ Optional
- `sqlfluff <https://github.com/sqlfluff/sqlfluff>`_
- `Valgrind <https://www.valgrind.org/>`_
-*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are using the Nix shell
-configuration as provided.*
+*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are
+using the Nix shell configuration as provided.*
Benchmarking
------------