aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Spiers <git@adamspiers.org>2015-01-11 21:21:47 +0000
committerAdam Spiers <git@adamspiers.org>2015-01-11 21:21:47 +0000
commit3ac083bbb4191ca8f8249427d9c69b3da8feff3d (patch)
treee9fbe87ef2f2bd3f5c7786a166a09ff39bdbe0ee /README.md
parent86a3e70128cc19de91cbb4708db87dbd4829c91b (diff)
downloadgit-deps-3ac083bbb4191ca8f8249427d9c69b3da8feff3d.tar.gz
clarify that it needs to be run from the repo root
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 57d57ee..02803c0 100644
--- a/README.md
+++ b/README.md
@@ -89,7 +89,11 @@ Usage
-----
The tool is not yet fully documented, but usage is fairly
-self-explanatory if you run with `-h`.
+self-explanatory if you run `git deps -h`.
+
+Currently you should run it from the root (i.e. top directory) of the
+git repository you want to examine; this is a
+[known limitation](https://github.com/aspiers/git-deps/issues/27).
By default it will output all dependencies of the given commit-ish(s),
one per line. With `--recurse`, it will traverse dependencies of