watodo

A little program that I made in nim to try out the language.

This is a todo list CLI program that allows the user to create tasks and later mark them as done.

Build

To build the project on your own machine, make sure you have nim installed correctly and available in your PATH environment variable.

After that you run the following command:

$ nimble build

With this command run, a new executable called 'watodo' should have been created, this is the compiled program.

Finally, it would be a good idea to make sure the executable is available in your PATH environment variable, to make it easier to use in any directory of your computer.

Usage

The program contains a few simple commands:

init
show
add
remove
finish

'init' command

Initializes a new todo list for the current directory (there can only be 1 todo list per directory)

'show' command

Shows all the registered tasks, displaying their status(TODO or DONE), ID and the description of the task.

'add' command

Adds a new task to the todo list.

When using this command you will need to provide a description for the task, and you can do that like this:

$ watodo add "Task Description"

So if you want to create a task with the description "Fix Bugs", this is the command you will need to type:

$ watodo add "Fix Bugs"

'remove' command

Removes a task from the todo list.

When using this command you will need to specify the ID of the task that you want to remove, this is the way to do it:

$ watodo remove ID

So if you want to remove a task that has ID of 2, you do it like this:

$ watodo remove 2

'finish' command

Marks a task as finished.

When using this command you will need to specify the ID of the task that you want to finish, this is the way to do it:

$ watodo finish ID

So if you want to finish a task that has ID of 3, you do it like this:

$ watodo finish 3

License

MIT

Porem5002/watodo