Skip to content

Commit

Permalink
Merge pull request #95 from lordgareth10/master
Browse files Browse the repository at this point in the history
Update UG
  • Loading branch information
lordgareth10 committed Apr 4, 2024
2 parents d027b8f + 9a0e416 commit f30228c
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ the tracking and management objectives can be achieved more efficiently.
#### Target user and value proposition
BookBuddy targets people who are comfortable and proficient with using command-line-interfaces(CLI). These users
typically prefers the efficiency and flexibility of CLI environments over Graphical user Interfaces (GUIs). They are
likely to be avid readers who read multiple books simultaneously and need an effective way to organise their reading
likely to be avid readers who read multiple books simultaneously and who need an effective way to organise their reading
lists.

Therefore, BookBuddy offers a streamlined and efficient solution for tracking and managing reading lists directly from
Expand Down Expand Up @@ -94,7 +94,7 @@ remember to read it soon....
````

### Removing a book: `remove`
Removes a specific book from the book list.
Removes a specific book from the book list by its index.

Format: `remove [BOOK_INDEX]`

Expand Down Expand Up @@ -164,7 +164,7 @@ Successfully marked Harry Potter as unread.

### Setting the genre of a book: `set-genre`

Sets the genre of a specific book based on the provided input.
Sets the genre of a specific book based on the provided input and the provided index.

Format: `set-genre [BOOK_INDEX]` followed by `[NUMBER]` then `[CUSTOM_GENRE]` if 6 is entered
in the previous step
Expand Down Expand Up @@ -216,7 +216,7 @@ Genre set to Fiction for book at index 1

### Labelling a book: `label`

Sets the label of a specific book to the provided input.
Sets the label of a specific book to the provided input by its index.

Format: `label [BOOK_INDEX] [LABEL]`

Expand Down Expand Up @@ -411,7 +411,13 @@ Thank you for using BookBuddy! Hope to see you again keke :)

**A**: All data entered is automatically saved by the program and does not require any
commands from the user. Upon running the file for the first time, the `books.txt` file
will be created in the `data` folder. This folder will be in the same folder as the JAR file.
will be created in the `data` folder. This folder will be in the same folder as the JAR file (For example, if
JAR file is located in /Users/ZongYao/Desktop then the `books.txt` will be located in /Users/ZongYao/Desktop/data).

**Q**: What happens if I give an invalid command or command argument?

**A**: All invalid commands and invalid arguments are handled gracefully with exceptions. You will just
be prompted to re-enter the command with an instruction on how to properly type the command.

**Users MUST exit the program with the `bye` command for the data in the session
to be saved.**
Expand Down

0 comments on commit f30228c

Please sign in to comment.