--- comment README
--------INTRODUCTION
So, what's the big deal about 'comment' ? Nothing really, comment is just meant to be a tiny tool which will allow you to leave little 'comments' over your directories so that if at any time later you want to come back and see what was going on you have a time/date stamped record.
A great aspect about 'comment' is that your comments are actually stored in [at least] two locations, 1: in the present working directory in a file called ".comment", 2: in your home directory under ~/.comment/comments. The home directory version is a collective version of all the comments you've made, where's the .comment files in the directories will be a combination of comments left by all people who have 'commented'.
'comment' is designed to be -really simple-. One of the biggest hurdles I found when attempting to use 'productivity' software was that it often took me longer to invoke, write, store, search the data than it would using a simple pen/paper method. 'comment' can be used from the command line as simple as "comment add 'this is my simple comment'".
--------USING 'comment'
To add a comment:
comment add 'put your comment here'
This will prefix your comment to the current directory's .comment
file as well as to ~/.comment/comments ( assuming you have
the permissions to do either )
To find a comment:
comment find 'what I am looking for'
or
comment findhome 'look for me in my home respository'
or
comment findhere 'look for me in the local .comment file'
or
comment findall 'look for me here and in my home respository'
--------FILE FORMAT of .comment / comments files
'comment' files are plain text files. You can edit them with any plain text editor you so choose if you wish, you can also use the normal shell utilities and tools to extract / manipulate the information contained in the 'comment' files.
The only 'restriction' imposed by 'comment' on the format of the files is that any line starting with a '' character will be consider the start of a new comment. If comment is asked to insert a comment with a leading '' character, it will convert it into a "\#" sequence.
--------CONTACTS
home page: http://www.pldaniels.com/contact
email: comment200302@pldaniels.com
--------END