hit9 / todo.c

Command line lightweight todo tool with readable storage , written in C.
BSD 2-Clause "Simplified" License
132 stars 23 forks source link

Added: manual page in POD format #15

Closed lindig closed 8 years ago

lindig commented 8 years ago

I've added a manual page for Unix systems. To avoid dealing with the native Troff format, I've written it in Perl's POD format and provided a Makefile rule to translate it from todo.pod to todo.1. The resulting file would be typically installed into man/man1/todo.1 but I haven't added this to the install target so far.

hit9 commented 8 years ago

Thanks very much!

I think we can provide a makefile entry named install-manual? Or just put this task in install?

lindig commented 8 years ago

Sure. The current Makefile is not very idiomatic. I could propose a more idiomatic one which takes care of this. In particular, I think it is very unusual to install the binary into $HOME/.todo and using an alias rather than into $HOME/bin/todo, or, more generally, into $PREFIX/bin/todo and the manual page into $PREFIX/man/man1. A few more suggestions:

hit9 commented 8 years ago

Hmm.. I agree with you now: we can install the binary to system $PATH now.