Ignore Emacs auto-save files

[topgit.git] / README

diff --git a/README b/README
index c418ff41a694b3920af6854d01f8b64f1ecc94d4..d7dfb5f6497ca03776f7c883b493e4a365332922 100644 (file)
--- a/README
+++ b/README
@@ -351,6 +351,17 @@ tg summary
        pass '--graphviz' to get a dot-suitable output to draw a dependency
        graph between the topic branches.
 
+       You can also use the --sort option to sort the branches using
+       a topological sort.  This is especially useful if each
+       TopGit-tracked topic branch depends on a single parent branch,
+       since it will then print the branches in the dependency
+       order.  In more complex scenarios, a text graph view would be
+       much more useful, but that is not yet implemented.
+
+       The --deps option outputs dependency informations between
+       branches in a machine-readable format.  Feed this to "tsort"
+       to get the output from --sort.
+
        TODO: Speed up by an order of magnitude
        TODO: Text graph view