ref: 240e13129dbe879652f11f491e4184db33b4ab5c
parent: 17b61799d9ecad647f6ce863882d19644476c1d8
author: M Misch <michaelmisch1985@gmail.com>
date: Tue Oct 8 16:08:19 PDT 2019
Update README.md
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# todocli
+# todo2
This simple script makes us of Make's directed acyclic graph solving, to express TODO lists in a way that allows multiple hierarchies of parent/child relationships between different atomic tasks.
@@ -62,5 +62,6 @@
## Automatically generate .todo files
Now, no one wants to write all that out all the time. Shouldn't this be able to pull a generic `// TODO:` tag, or `# TODO:`, etc? Yeah, I thought so too.
-`todocli 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` it will be added automatically, in an entry similar to the one above.
-
+`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