Skip to content

Commit

Permalink
Fix and finalize styling and format of user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
MAOXIONGKAI committed Sep 19, 2024
1 parent 0a6413d commit f7ca2ee
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gopher User Guide

<img src="Ui.png" alt="ScreenShot of Gopher's UI for showcase to the user" width="70%" />
<img src="Ui.png" alt="ScreenShot of Gopher's UI for showcase to the user" width="500" />

## Menu
- [Introduction](#introduction)
Expand Down Expand Up @@ -39,7 +39,7 @@ Store, Manage and Query the tasks just like how you talk to a person in real lif

## Set Up
Setting up Gopher is easier than you think! Just follow these simple steps and you are ready to go!
1. Settle Dependencies: Ensure that Java 17 or above is installed on your machine
1. Settle Dependencies: Ensure that Java 17 is installed on your machine
2. Get the Jar File: Download jar file from the latest release and put in a folder
3. Wake Gopher Up: Use command prompt to navigate to the folder that contains the jar file, and run
`java -jar Gopher.jar`
Expand All @@ -61,22 +61,22 @@ With a command:
- `{text}` are optional part of the command

### Add todo
Todo is a type of task that only contains description/name of the task, it can be created using:\
Todo is a type of task that only contains description(or name) of the task, it can be created using:\
`todo [taskName]`

Example: `todo Wash Clothes`
**Example**: `todo Wash Clothes`

### Add deadline
Deadline is a type of task that contains a due date, it can be created using:\
`deadline [taskName] /by [due date time]`

Example: `deadline iP Final Submission /by 2024-09-20 23:59`
**Example**: `deadline iP Final Submission /by 2024-09-20 23:59`

### Add event
Event is a type of task that contains a start and end date, it can created using:\
`event [taskName] /from [start date time] /to [end date time]`

Example: `event Orbital Splashdown /from 2024-08-28 16:00 /to 2024-08-28 21:00`
**Example**: `event Orbital Splashdown /from 2024-08-28 16:00 /to 2024-08-28 21:00`

### List all tasks
You can list out all the tasks that are current tracked by Gopher using:\
Expand All @@ -86,26 +86,26 @@ You can list out all the tasks that are current tracked by Gopher using:\
You can mark multiple tasks as done using:\
`mark [task number]...`

For example: `mark 1 2 3`
**Example**: `mark 1 2 3`

### Mark tasks as not done
You can mark multiple tasks as not done using:\
`unmark [task number]...`

For example: `unmark 1 2 3`
**Example**: `unmark 1 2 3`

### Update todo
You can update a todo task using:\
`update [task number] [new task name]`

For example:\
**Example**:\
If you want to update a todo task with task number 1 with new task name `Assignment 1`, input:\
`update 1 Assignment 1`

### Update deadline
You can update a deadline task using:\
`deadline [task number] {new task name} {/by new due date time}`\
For example:\
**Example**:\
If you want to update a deadline task with task number 2 with the following information:
- New task name: `CS2101 OP1 Synopsis`
- New due date time: `2024-09-12`\
Expand All @@ -117,11 +117,11 @@ You can input the update command like this:\
You can update an event task using:\
`event [task number] {new task name} {/from new start date time} {/to new end date time}`

For example:
**Example**:\
If you want to update an event task with task number 3 with the following information:
- New task name: `CS2100 Midterm Exam`
- New start date time: `2024-10-10 10:00`
- New end date time: `2024-10-10 12:00`\
- New end date time: `2024-10-10 12:00`

You can input the update command like this:\
`update 3 CS2100 Midterm Exam /from 2024-10-10 10:00 /to 2024-10-10 12:00`
Expand All @@ -130,15 +130,15 @@ You can input the update command like this:\
You can find tasks that match a certain keyword using:\
`find [keyword]`

For example:\
**Example**:\
If you want to find all tasks tracked by Gopher that contains the keyword `Orbital`, input:\
`find Orbital`

### Delete tasks
You can delete multiple tasks using:\
`delete [task number]...`

For example: `delete 1 2 3`
**Example**: `delete 1 2 3`

### Exit
You can say goodbye to Gopher using:\
Expand Down

0 comments on commit f7ca2ee

Please sign in to comment.