summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-03-01 20:17:15 +0200
committerPaul Buetow <paul@buetow.org>2026-03-01 20:17:15 +0200
commit6a2f4eb250fa857fb5c619107c4a5b02b51a3104 (patch)
tree583f98b79603d3866e465c7ce1a559ff30c3a07e
parent4c2d1e5b2ee0792b1a8ca3b330fd391c6bdb8285 (diff)
clarify location of rcm CLI tool in cli example README
-rw-r--r--examples/cli/README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/examples/cli/README.md b/examples/cli/README.md
index d393a9c..e88c6bc 100644
--- a/examples/cli/README.md
+++ b/examples/cli/README.md
@@ -1,6 +1,18 @@
# Example: Via CLI
-Uses RCM through the `rcm` command-line tool.
+Uses RCM through the `rcm` command-line tool located at `bin/rcm` in the repository root.
+
+To make it available on your `PATH`:
+
+```sh
+export PATH="$PATH:/path/to/rcm/bin"
+```
+
+Or invoke it directly:
+
+```sh
+/path/to/rcm/bin/rcm config.rb --dry
+```
## Usage