Skip to content

Commit df49c9d

Browse files
committed
Added documentation of my use cases to the README file
1 parent daec1a6 commit df49c9d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ This is a flashcard study application inspired by Quizlet.
1616
- If the user selects the "Log In" option from the welcome screen the user may input their respective username and password, if the username does not match an existing username from the database or incorrect password they shall be warned.
1717

1818
### 2. Create a flashcard or a flashcard set.
19+
- Flashcard Set:
20+
- The user can create a flashcard set by clicking the "Add Flashcard Set" button located on the main page
21+
- Once the button is clicked, the user is taken to the flashcard set creation screen
22+
- The user can then enter a title and description for the flashcard set
23+
- If the user clicks on "Create" with either the title or description missing, the user is alerted to include them
24+
- The user can also make the flashcard set Public (unchecked box) or Private (checked box)
25+
- Note: public flashcard sets are searchable by other users, while private ones are not (unless those users are Admins)
26+
- If the user wishes to cancel the creation, they can do so by clicking "Cancel"
27+
- Upon successful creation, the user is notified that their flashcard set has been created
1928

2029
### 3a. Edit a flashcard set.
2130
- If there are no flashcard sets on the main page, then we cannot edit a flashcard set.
@@ -29,6 +38,14 @@ This is a flashcard study application inspired by Quizlet.
2938
- If there are flashcards, the user can choose which flashcard to edit by clicking the "Edit Flashcard" button. When clicked a window pops up with Term and Definition text prompts for the user to edit. The user cannot change the Term to an empty term.
3039

3140
### 4. Delete a flashcard or a flashcard set.
41+
- Flashcard Set:
42+
- The user can delete a flashcard set by clicking the "Delete" button located inside a flashcard set's options box on the main page
43+
- When the button is clicked, the user is then taken to the flashcard set deletion screen
44+
- On this screen, user can cancel the deletion at any time by clicking the "Cancel" button
45+
- If the user clicks on "Delete", the user is presented with a confirmation dialog box
46+
- Selecting "No" cancels the deletion and selecting "Yes" commences the deletion process
47+
- Note: deleting a flashcard set would also delete all flashcards contained within that set
48+
- Upon successful deletion, the user is notified that their flashcard set has been deleted
3249

3350
### 5. Search for a public flashcard set.
3451
- If the user selects the search button from the main page the user can search through the public community database for flashcard sets

0 commit comments

Comments
 (0)