Skip to content

Latest commit

 

History

History
117 lines (81 loc) · 3.11 KB

README.md

File metadata and controls

117 lines (81 loc) · 3.11 KB
Raw

TODO-APP-CMD

A todo app in c++, executable from command line (currently windows).

This was the programming task under CoronaSafe Engineering Fellowship Program.

IMPORTANT STEP

  1. Clone the repository on your local machine.
  2. Open Command line in Windows.
  3. Install g++ MINGW on your PC (Ignore if you have already). Link:- https://sourceforge.net/projects/mingw-w64/
  4. Run this command to compile the cpp file:- "g++ -o todo todo.cpp"
  5. Run this command to execute/run the "todo app" :- ./todo
  6. The above command will print the list of commands you can run in the app.

Specification

  1. The app can be run in the console with ./todo.
  2. Each todo item occupies a single line in this file. Here is an example file that has 2 todo items.
water the plants
change light bulb

  1. When a todo item is completed, it is removed from todo.txt and instead added to the done.txt text file. This file has a different format:

    x 2020-06-12 the text contents of the todo item
    1. the letter x
    2. the current date in yyyy-mm-dd format
    3. the original text

    The date when the todo is marked as completed is recorded in the yyyy-mm-dd format (ISO 8601). For example, a date like 15th August, 2020 is represented as 2020-08-15.

Usage

1. Help

Executing the command without any arguments, or with a single argument help prints the CLI usage.

$ ./todo help
Usage :-
$ ./todo add "todo item"  # Add a new todo
$ ./todo ls               # Show remaining todos
$ ./todo del NUMBER       # Delete a todo
$ ./todo done NUMBER      # Complete a todo
$ ./todo help             # Show usage
$ ./todo report           # Statistics

2. List all pending todos

Use the ls command to see all the todos that are not yet complete. The most recently added todo are displayed first.

$ ./todo ls
[2] change light bulb
[1] water the plants

3. Add a new todo

Use the add command. The text of the todo item is enclosed within double quotes (otherwise only the first word is considered as the todo text, and the remaining words are treated as different arguments).

$ ./todo add "the thing i need to do"
Added todo: "the thing i need to do"

4. Delete a todo item

Use the del command to remove a todo item by its number.

$ ./todo del 3
Deleted todo #3

Attempting to delete a non-existent todo item displays an error message.

$ ./todo del 5
Error: todo #5 does not exist. Nothing deleted.

5. Mark a todo item as completed

Use the done command to mark a todo item as completed by its number.

$ ./todo done 1
Marked todo #1 as done.

Attempting to mark a non-existed todo item as completed will display an error message.

$ ./todo done 5
Error: todo #5 does not exist.

6. Generate a report

Use the report command to see the latest tally of pending and completed todos.

$ ./todo report
yyyy-mm-dd Pending : 1 Completed : 4

This README.md file is modified version of file available on below given repository link.

Original Readme.md file repo is -> Github Repo