This is a user guide for Remi, a c(h)atbot for managing your different tasks.
Prerequisite: Ensure java 11 is downloaded on your computer
- Open github and go to this repository: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
- Download remi.jar from
Code>Releases>ip v0.2>remi.jar - Run
remi.jarby double-clicking on file explorer or by running./remi.jaron terminal. - A program called Remi should show up now, with a welcome message.
- Type a command in the text box and press Enter. This will execute it and return a message. These are some sample commands:
todo go homewill create a todo task called go homelistwill list all your tasksdelete 1will delete your first task on the listexitwill close the app
There are three main types of task in this app: todos, deadlines, and events.
- Format:
todo LABEL
- Format:
todo LABEL /by TIME
- Format:
event LABEL /from TIME /to TIME
LABELandTIMEcannot be blank or an error may occur. Note that all tags (/by,/from,/to) are all required for their respective tasks.
Simply shows a list of all tasks in the task list. This is the list arrangement to be used for indexing purposes.
Shows a list of all tasks in the task list. This is used only for viewing, in all future commands the alphabetical indices are not used.
- Format:
mark INDEX
This marks a task as finished.INDEXmust be provided and must be a number between 1 and the size of the list or an error may occur e.g. 1, 2, 3. Words such as one, two, or three will not be acceptable
TheINDEXshould be based on the indexing given by thelistcommand and not thelistsortorfindcommands.
- Format:
mark INDEX
This unmarks a task, making the task unfinished.
See previous notes regardingINDEXin themarksection
- Format:
find QUERY_STRING
This finds any task that have theQUERY_STRINGas part of their label.QUERY_STRINGmay be empty.
Examples: gowill find tasks labelled:go home,go to church,government errandsbuy placewill find tasks labelled:buy place at 1,buy placebo,government errandsbuy placewill NOT find tasks labelled:place buy in market
- Format:
delete INDEX
This deletes a task, removing it from the list. Deleted tasks aren't recoverable so be careful!
See previous notes regardingINDEXin themarksection
All work is automatically saved whenever the list of tasks is changed. There is no need to save changes manually.
Exits the remi application, equivalent to pressing the X button on the GUI.