ref: 6d6cf907082821777026edcc619632e45c97dd78
parent: 240e13129dbe879652f11f491e4184db33b4ab5c
author: M Misch <michaelmisch1985@gmail.com>
date: Tue Oct 8 16:18:54 PDT 2019
Update README.md
--- a/README.md
+++ b/README.md
@@ -65,3 +65,14 @@
`todo generate` will walk the source tree, looking `TODO`, `BUG`, `RELEASE`, and other related tags. If they have a tag, such as `BUG #92930: Trying to seek returns incomprehensible error when calling SomeCall` an entry will be made in an appropriate .todo file in that particular source directory/subdirectory, which will be created as necessary.
- files with extensions will have the extension replaced with .todo, and files without extensions will gain the extension .todo. Name collisions should be benign here.
- more extensive coverage of tagging conventions can be Pull Requested as needed by users
+
+## Managing dependancy hierarchy
+
+To say a particular .todo depends on another, we can manually edit the Makefile, or we can use the wrapper scripts to simplify the process.
+`todo add` is the base command we'll be using, to add hierarchies. (A complementary `todo rm` can be used to undo anything `todo add` can do!)
+To add something as a child dependancy, `todo add child <parent name> <child name>`. From the above examples, you would issue `todo add child 'BUG #01209' 'BUG #92930'`, or equivilently `todo add parent 'BUG #92930' 'BUG #01209'`. Arbitrarily many dependancies can be added between arbitrary pieces within the current working source tree.
+
+## Commands of intrigue
+ - `todo list` will output a list of all current leaves in the graph, (nodes which have no pending dependancies)
+ - `todo listall` will list every piece of the graph in a flat structure. This is very useful in defining hierarchies on complicated TODO list
+ - `todo dot` can be piped to `graphviz` and friends to view your current task hierarchies, with the completed nodes elided