Add some more instructions for newbies

[the-solipsist]

trafficstars

Hi Ingo. Thanks for all the fantastic work you've put into these actions and filters. It'd be great if you could add some instructions for newbies who come by this and wish to adopt your extensions (actions + filters).

I'm specifically thinking of something like https://github.com/ginatrapani/todo.txt-cli/wiki/Quick-Start-Guide for how to use your extensions.

[inkarkat]

It's on my todo list :-) I agree that more documentation and test coverage would be great. Right now, my focus is on supporting my personal workflow; I've published this mostly to answer specific questions on the mailing list; as a side effect, this may also allow others to benefit from whatever they can take (like some of my actions were inspired or even based on the actions of others).

So, yes, I'll eventually get to this, but as this is a one-man project in my spare time, please don't expect rapid progress. If you have a specific problem, I'd recommend to reach out to the todo.txt mailing list; maybe I have something in my toolbox, maybe others have an alternative.

[the-solipsist]

I think the documentation through the comments within the files themselves is great, but what would perhaps be helpful in the readme.md is a very simple list of steps. Something like this (assuming this is correct):

1. Download stable version of todo.sh and todo_completion from Gina's github page
2. Download todo.cfg, actions, filters, lib from here, and place them in the same folder.
3. Chmod +x todo.sh and all the files within actions.
4. Edit todo.cfg and change file locations and colour settings
5. Source todo_completion and common.sh from .bashrc, and add a line to use the alias 't' for todo.sh.
6. Reload .bashrc using $ source .bashrc
7. Start using todo.sh...

... Or something like that?

The above could also be changed to git pull commands (instead of "download") + ln commands.