diff options
Diffstat (limited to 'examples/cross_todo/nim_commandline/readme.txt')
| -rw-r--r-- | examples/cross_todo/nim_commandline/readme.txt | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/cross_todo/nim_commandline/readme.txt b/examples/cross_todo/nim_commandline/readme.txt new file mode 100644 index 000000000..ca4b67521 --- /dev/null +++ b/examples/cross_todo/nim_commandline/readme.txt @@ -0,0 +1,19 @@ +This directory contains the Nim commandline version of the todo cross +platform example. + +The commandline interface can be used only through switches, running the binary +once will spit out the basic help. The commands you can use are the typical on +such an application: add, check/uncheck and delete (further could be added, +like modification at expense of parsing/option complexity). The list command is +the only one which dumps the contents of the database. The output can be +filtered and sorted through additional parameters. + +When you run the program for the first time the todo database will be generated +in your user's data directory. To cope with an empty database, a special +generation switch can be used to fill the database with some basic todo entries +you can play with. + +Compilation is fairly easy despite having the source split in different +directories. Thanks to the Nim.cfg file, which adds the ../Nim_backend +directory as a search path, you can compile and run the example just fine from +the command line with 'nim c -r nimtodo.nim'. |