Skip to content

Commit f4b9e94

Browse files
Update README.md
1 parent 500fe35 commit f4b9e94

File tree

2 files changed

+40
-40
lines changed

2 files changed

+40
-40
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
#Lati
1+
# Lati
22

33
Lati is a desktop chat app for managing tasks and trivia, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).
44

5-
##**How to install:**
5+
## **How to install:**
66

77
1. Ensure you have Java 11 or above installed in your computer. You can check the version of your Java installation by opening the command prompt of your terminal and typing `java -version`
88

@@ -17,9 +17,9 @@ A GUI similar to the below should appear in a few seconds. Note how the app cont
1717

1818
6. Refer to the Features below for details of each command
1919

20-
##**Features:**
20+
## **Features:**
2121

22-
###Adding a todo task: `todo`
22+
### Adding a todo task: `todo`
2323

2424
Adds a todo task to the list of tasks. A todo task is a task with no set deadline.
2525

@@ -29,7 +29,7 @@ Examples
2929
- `todo wash the dishes`
3030
- `todo get a haircut`
3131

32-
###Adding a deadline task: deadline
32+
### Adding a deadline task: deadline
3333

3434
Adds a deadline task to the list of tasks. A deadline task is a task with a deadline
3535

@@ -39,7 +39,7 @@ Examples
3939
- `deadline iP /by 2023-09-22`
4040
- `deadline tP /by 2023-10-02`
4141

42-
Note: DEADLINE must be in "YYYY-MM-DD" format
42+
Note: `DEADLINE` must be in "YYYY-MM-DD" format
4343

4444
Adding an event task: `event`
4545
Adds an event task to the list of tasks. An event task is a task with a start and end date.
@@ -49,24 +49,24 @@ Format: `event t/NAME_OF_TASK /from f/START_DATE /to e/END_DATE`
4949
Examples
5050
- `event Play Team Fortress 2 /from 2023-09-22 /to 2023-11-22`
5151

52-
Note: All dates (START_DATE and END_DATE must be in "YYYY-MM-DD" format).
53-
In addition, START_DATE must be before or equal to the END_DATE
52+
Note: All dates (`START_DATE` and `END_DATE` must be in "YYYY-MM-DD" format).
53+
In addition, `START_DATE must` be before or equal to the `END_DATE`
5454

55-
###Marking a task: `mark`
55+
### Marking a task: `mark`
5656
Marks a task as "done".
5757

5858
Format: `mark i/INDEX`
5959

6060
Note: Marks the task at the specified `INDEX`. The index refers to the index number shown in the displayed list. The index MUST be a positive integer.
6161

62-
###Unmarking a task: `unmark`
62+
### Unmarking a task: `unmark`
6363
Unmarks a completed task.
6464

6565
Format: `unmark i/INDEX`
6666

6767
Note: Unmarks the task at the specified `INDEX`. The index refers to the index number shown in the displayed list. The index MUST be a positive integer.
6868

69-
###Deleting a task: `delete`
69+
### Deleting a task: `delete`
7070
Deletes a task.
7171

7272
Format: `delete i/INDEX`
@@ -79,18 +79,18 @@ Notes:
7979
Showing all tasks: `list`
8080
Shows the current tasks stored
8181

82-
###Searching a task: `search`
82+
### Searching a task: `search`
8383

8484
Searches a task with a given keyword
8585

8686
Format: `search k/KEYWORD`
8787

88-
###Showing all tasks: `list`
88+
### Showing all tasks: `list`
8989

9090
Format: `list`
9191

9292

93-
###Adding trivia: `addtrivia`
93+
### Adding trivia: `addtrivia`
9494
Adds a trivia question and corresponding answer to the Dukebot.
9595

9696
Format: `addtrivia q/QUESTION /answer a/ANSWER`
@@ -100,29 +100,29 @@ Examples
100100
- `addtrivia Who owns the Yamato /answer Vergil`
101101

102102

103-
###Editing trivia: `edittrivia1
103+
### Editing trivia: `edittrivia1
104104
Edits the answer of a particular trivia question
105105

106-
Format: `edittrivia q/QUESTION /answer a/NEW_ANSWER1
106+
Format: `edittrivia q/QUESTION /answer a/NEW_ANSWER1`
107107

108108
Examples
109109
- editTrivia Who owns the Yamato /answer Japan Edits the `Who owns the Yamato` trivia answer to be `Japan` instead of `Vergil`
110110

111-
###Answering trivia: `ask`
111+
### Answering trivia: `ask`
112112
Incites a response if Lati knows the answer to said trivia
113113

114114
Format: `ask q/QUESTION`
115115

116116
Examples
117117
- `ask Who owns the Yamato` returns `Japan`
118-
- `ask Who is the Hobgoblin` returns `I don't tink I know...`
118+
- `ask Who is the Hobgoblin` returns `I don't know...`
119119

120-
###Deleting trivia: `deletetrivia`
120+
### Deleting trivia: `deletetrivia`
121121
Removes a trivia question
122122

123123
Format: `deletetrivia q/QUESTION`
124124

125-
###Closing the chatbot: `bye`
125+
### Closing the chatbot: `bye`
126126

127127
Format: `bye`
128128

docs/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
#Lati
1+
# Lati
22

33
Lati is a desktop chat app for managing tasks and trivia, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).
44

5-
##**How to install:**
5+
## **How to install:**
66

77
1. Ensure you have Java 11 or above installed in your computer. You can check the version of your Java installation by opening the command prompt of your terminal and typing `java -version`
88

@@ -17,9 +17,9 @@ A GUI similar to the below should appear in a few seconds. Note how the app cont
1717

1818
6. Refer to the Features below for details of each command
1919

20-
##**Features:**
20+
## **Features:**
2121

22-
###Adding a todo task: `todo`
22+
### Adding a todo task: `todo`
2323

2424
Adds a todo task to the list of tasks. A todo task is a task with no set deadline.
2525

@@ -29,7 +29,7 @@ Examples
2929
- `todo wash the dishes`
3030
- `todo get a haircut`
3131

32-
###Adding a deadline task: deadline
32+
### Adding a deadline task: deadline
3333

3434
Adds a deadline task to the list of tasks. A deadline task is a task with a deadline
3535

@@ -39,7 +39,7 @@ Examples
3939
- `deadline iP /by 2023-09-22`
4040
- `deadline tP /by 2023-10-02`
4141

42-
Note: DEADLINE must be in "YYYY-MM-DD" format
42+
Note: `DEADLINE` must be in "YYYY-MM-DD" format
4343

4444
Adding an event task: `event`
4545
Adds an event task to the list of tasks. An event task is a task with a start and end date.
@@ -49,24 +49,24 @@ Format: `event t/NAME_OF_TASK /from f/START_DATE /to e/END_DATE`
4949
Examples
5050
- `event Play Team Fortress 2 /from 2023-09-22 /to 2023-11-22`
5151

52-
Note: All dates (START_DATE and END_DATE must be in "YYYY-MM-DD" format).
53-
In addition, START_DATE must be before or equal to the END_DATE
52+
Note: All dates (`START_DATE` and `END_DATE` must be in "YYYY-MM-DD" format).
53+
In addition, `START_DATE must` be before or equal to the `END_DATE`
5454

55-
###Marking a task: `mark`
55+
### Marking a task: `mark`
5656
Marks a task as "done".
5757

5858
Format: `mark i/INDEX`
5959

6060
Note: Marks the task at the specified `INDEX`. The index refers to the index number shown in the displayed list. The index MUST be a positive integer.
6161

62-
###Unmarking a task: `unmark`
62+
### Unmarking a task: `unmark`
6363
Unmarks a completed task.
6464

6565
Format: `unmark i/INDEX`
6666

6767
Note: Unmarks the task at the specified `INDEX`. The index refers to the index number shown in the displayed list. The index MUST be a positive integer.
6868

69-
###Deleting a task: `delete`
69+
### Deleting a task: `delete`
7070
Deletes a task.
7171

7272
Format: `delete i/INDEX`
@@ -79,18 +79,18 @@ Notes:
7979
Showing all tasks: `list`
8080
Shows the current tasks stored
8181

82-
###Searching a task: `search`
82+
### Searching a task: `search`
8383

8484
Searches a task with a given keyword
8585

8686
Format: `search k/KEYWORD`
8787

88-
###Showing all tasks: `list`
88+
### Showing all tasks: `list`
8989

9090
Format: `list`
9191

9292

93-
###Adding trivia: `addtrivia`
93+
### Adding trivia: `addtrivia`
9494
Adds a trivia question and corresponding answer to the Dukebot.
9595

9696
Format: `addtrivia q/QUESTION /answer a/ANSWER`
@@ -100,29 +100,29 @@ Examples
100100
- `addtrivia Who owns the Yamato /answer Vergil`
101101

102102

103-
###Editing trivia: `edittrivia1
103+
### Editing trivia: `edittrivia1
104104
Edits the answer of a particular trivia question
105105

106-
Format: `edittrivia q/QUESTION /answer a/NEW_ANSWER1
106+
Format: `edittrivia q/QUESTION /answer a/NEW_ANSWER1`
107107

108108
Examples
109109
- editTrivia Who owns the Yamato /answer Japan Edits the `Who owns the Yamato` trivia answer to be `Japan` instead of `Vergil`
110110

111-
###Answering trivia: `ask`
111+
### Answering trivia: `ask`
112112
Incites a response if Lati knows the answer to said trivia
113113

114114
Format: `ask q/QUESTION`
115115

116116
Examples
117117
- `ask Who owns the Yamato` returns `Japan`
118-
- `ask Who is the Hobgoblin` returns `I don't tink I know...`
118+
- `ask Who is the Hobgoblin` returns `I don't know...`
119119

120-
###Deleting trivia: `deletetrivia`
120+
### Deleting trivia: `deletetrivia`
121121
Removes a trivia question
122122

123123
Format: `deletetrivia q/QUESTION`
124124

125-
###Closing the chatbot: `bye`
125+
### Closing the chatbot: `bye`
126126

127127
Format: `bye`
128128

0 commit comments

Comments
 (0)