aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-06-07 03:11:52 +0000
committerFuwn <[email protected]>2021-06-07 03:11:52 +0000
commita61e1ef56a70dacbb2872a259d7fde497d19a576 (patch)
treec6a6e50259e9bddc907a5a3c95bd431d5de6d23d
parentfix(readme): move code-block to seperate block (diff)
downloadwhirl-a61e1ef56a70dacbb2872a259d7fde497d19a576.tar.xz
whirl-a61e1ef56a70dacbb2872a259d7fde497d19a576.zip
docs(readme): dev deps now each have a little description
-rw-r--r--README.rst13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index e937965..b926367 100644
--- a/README.rst
+++ b/README.rst
@@ -85,16 +85,17 @@ Development Dependencies
Required
~~~~~~~~
-- `Rust <https://www.rust-lang.org/>`_
-- `diesel\_cli <https://crates.io/crates/diesel_cli>`_
-- `cargo-make <https://github.com/sagiegurari/cargo-make>`_
+- `Rust <https://www.rust-lang.org/>`_, the backbone of it all.
+- `diesel\_cli <https://crates.io/crates/diesel_cli>`_, database migrations, setup, et cetera.
+- `cargo-make <https://github.com/sagiegurari/cargo-make>`_, cross-platform
+ `make <https://www.gnu.org/software/make/>`_ substitute.
Optional
~~~~~~~~
-- `cargo-watch <https://crates.io/crates/cargo-watch>`_
-- `sqlfluff <https://github.com/sqlfluff/sqlfluff>`_
-- `Valgrind <https://www.valgrind.org/>`_
+- `cargo-watch <https://crates.io/crates/cargo-watch>`_, recompilation on file-system changes.
+- `sqlfluff <https://github.com/sqlfluff/sqlfluff>`_, SQL linting.
+- `Valgrind <https://www.valgrind.org/>`_, benchmarking.
*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are
using the Nix shell configuration as provided.*