aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Spiers <git@adamspiers.org>2015-01-12 23:10:58 +0000
committerAdam Spiers <git@adamspiers.org>2015-01-12 23:10:58 +0000
commit80d531898b434ade5f8f942025cb409b445922d1 (patch)
tree31f9be356b144e6595d0b40b6b73a4ff6a6c3eed /README.md
parent149f5253f8d0f92aaf93922e17b5c86df3f92178 (diff)
downloadgit-deps-80d531898b434ade5f8f942025cb409b445922d1.tar.gz
add hyperlinks with gitfile:// URLs (#29)
Closes #29.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index a093540..53fc85c 100644
--- a/README.md
+++ b/README.md
@@ -112,6 +112,25 @@ If you run with the `--serve` option then it will start a lightweight
webserver and output a URL you can connect to for dynamically
visualizing and navigating the dependency graph.
+### Setting up a `gitfile://` URL handler
+
+If you double-click any commit node on the dependency graph, your
+browser will be asked to launch a handler for a `gitfile://...` URL
+which points to that commit within the repository path on your local
+filesystem. So if you configure your browser desktop environment,
+you can have a program such as [`gitk`](http://git-scm.com/docs/gitk)
+launch for viewing further details of that commit. Obviously this
+only makes sense when viewing the graph via http://localhost.
+
+On most Linux machines, this can be set up via something like the
+following:
+
+ # First cd to the top of this git-deps repo.
+ repo="`pwd`"
+ ln -sf $repo/gitfile-handler ~/bin
+ ln -sf $repo/gitfile-handler.desktop ~/.local/share/applications
+ xdg-mime default gitfile-handler.desktop x-scheme-handler/gitfile
+
Development / support / feedback
--------------------------------