The following user guide is written for Window users. The application may or may not work with other operating systems. Makima is a desktop app for managing generic tasks. Makima implements the following type of tasks:
- ToDo: a named task
- Deadline: a named task with an end date
- Event: a named task with a start and end date
- Ensure you have Java
17or above installed.
How to check?
Run the following command in your command terminal:
java --version
- Download the latest jar file from here
- Copy the file to the folder you want to use as your home folder for the application.
- Run the following command in your command terminal:
java -jar makima.jar
Note on command syntax
Makima process each command in stages. For example, if the user wants to add a todo task, they must specify the name of the todo task. The application will then prompt for these input in seperate stages.
The command formats are then specified as follows:
- \n demarks the end of a stage of a command.
e.g. in
todo \n TASK_NAME, the user enters todo. After the bot replies and requests for the task name, the user enters the relevant task name. - Words in UPPER_CASE are parameters to be supplied by the user.
e.g. in
todo \n TASK_NAME, theTASK_NAMErefers to the desired task name. - Trailing and leading whitespaces are ignored.
Example
Why is done this way?
Some commands require quite a few inputs. Separating the command into stages means that if one of the fields is formatted wrongly, the user can simply reenter that specific field! Furthermore, we have implemented a return command so that if you would like to exit at any stage of the command, you may do so. See return.
Adds a todo.
Format: todo \n TASK_NAME
Examples
todo \n Buy groceriestodo \n Finish writing the reporttodo \n Call the dentist
Adds a deadline.
Format: deadline \n TASK_NAME \n END_DATE
Examples
deadline \n Submit assignment \n 2024-09-30T15:00deadline \n Pay electricity bill \n 2024-10-05T12:00deadline \n Prepare for meeting \n 2024-09-25T09:30
Adds an event.
Format: event \n EVENT_NAME \n START_DATE \n END_DATE
Examples
event \n Team lunch \n 2024-10-01T13:00 \n 2024-10-01T14:00event \n Birthday party \n 2024-11-15T18:00 \n 2024-11-15T21:00event \n Project kickoff \n 2024-09-28T10:00 \n 2024-09-28T11:30
Deletes a task.
Format: delete \n TASK_INDEX
Examples
delete \n 1(Deletes the first task)delete \n 3(Deletes the third task)
Marks a task as complete.
Format: mark \n TASK_INDEX
Examples
mark \n 2(Marks the second task as complete)mark \n 1(Marks the first task as complete)
Unmarks a task.
Format: unmark \n TASK_INDEX
Examples
unmark \n 1(Unmarks the first task)unmark \n 3(Unmarks the third task)
Displays the list of tasks.
Format: list
Examples
list(This will show all tasks)
Finds the task with name containing the specified string.
Format: find \n SEARCH_TERM
Examples
find \n report(Finds tasks containing "report")find \n groceries(Finds tasks containing "groceries")
Prioritises the selected task.
Format: prioritise \n TASK_INDEX \n PRIORITY
Examples
prioritise \n 2 \n high(Sets the priority of the second task to high)prioritise \n 1 \n low(Sets the priority of the first task to low)
Exits out the current command.
Format: return
Examples
return
Exits out the program.
Format: bye
Examples
bye
| Command | Description | Format |
|---|---|---|
todo |
Adds a todo | todo \n TASK_NAME |
deadline |
Adds a deadline | deadline \n TASK_NAME \n DATE |
event |
Adds an event | event \n EVENT_NAME \n START_DATE \n END_DATE |
delete |
Deletes a task | delete \n TASK_INDEX |
mark |
Marks a task as complete | mark \n TASK_INDEX |
unmark |
Unmarks a task | unmark \n TASK_INDEX |
list |
Displays the list of tasks | list |
find |
Finds tasks by name containing a string | find \n SEARCH_TERM |
prioritise |
Prioritises a task | prioritise \n TASK_INDEX \n PRIORITY |
return |
Exits the current command | return |
bye |
Exits the program | bye |
Image credits: