Skip to content

UserGuide.md

Latest commit

 

History

History
429 lines (341 loc) · 15.3 KB

UserGuide.md

File metadata and controls

429 lines (341 loc) · 15.3 KB

User Guide

Introduction

FlashCLI 2.0 is a command-line flashcard application designed specifically for CS2113 Software Engineering students. It helps students create, manage, and review flashcards efficiently, making it easier to retain important concepts in Java, software design, and coding best practices.

Quick Start

  1. Ensure you have Java 17 or above installed in your Computer.
    Mac users: Ensure you have the precise JDK version prescribed here.

  2. Download the latest .jar file from here.

  3. Copy the file to the folder you want to use as the home folder for FlashCLI.

  4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar FlashCLI.jar command to run the application.
    You should be greeted with a welcome message.

  5. Type the command in the command box and press Enter to execute it. e.g. typing user_guide and pressing Enter will list the available commands.
    Some example commands you can try:

    • new testDeck : Creates a new deck named "testDeck".

    • select 1 : Selects the first deck.

    • add /q What is an assertion? /a Assertions are used to... : Creates a new flashcard with the question and answer provided.

    • list: Shows the list of flashcards in the selected deck.

    • exit : Exits the app.

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

Features

  1. Flashcard Features
  2. Deck Features
  1. FAQ
  2. Command Summary

Flashcard Features

Viewing user guide: user_guide

Displays possible instructions that can be inputted.

Format: user_guide Example:

[INPUT]: user_guide
[OUTPUT]:
Quick Start:
Create a deck of flashcards with "new", select it with "select", and begin adding flashcards with "add"!

List of commands:
"add": creates a flashcard
"list": shows list of flashcards
"qn": views the flashcard's question
"ans": views the flashcard's answer
"delete": deletes the flashcard
"edit": edits the flashcard question/answer
"insert_code": inserts code snippet for a flashcard
"quiz": quizzes the unlearned flashcards
"mark_learned": marks flashcard as learned
"mark_unlearned": marks flashcard as unlearned
"view_res": views results from quiz after quiz is completed
"new": creates a new deck of flashcards
"rename": renames flashcard deck
"decks": shows list of decks
"select": selects a deck 
"remove": deletes a deck
"unselect": unselects a deck
"search": searches within a deck or globally
"exit": exits the program

Go to the flashCli User Guide website for more details

Create flashcards: add

Creates a flashcard which consists of the fields questions and answers and adds it to the selected deck. All fields are required. A deck must be selected first before using this command.

Refer to the Developer's Guide for more information on the command.

Format: add /q QUESTION /a ANSWER
Examples:

  • add /q What language is used in CS2113? /a Java → Adds a new flashcard with the question What language is used in CS2113? and answer Java to the current selected deck.

If no deck is selected, this command cannot be used.

Summary view of the flashcard deck: list

Shows a list of all the flashcards in your deck, including information about the index and question of each flashcard.

Format: list Examples:

[INPUT]: list
[OUTPUT]: 
1. [ ] What colour is an apple? 
2. [ ]] What language is used in CS2113?

View question only: qn

Show the question of a flashcard via its index.

Format: qn INDEX INDEX must be a positive integer, ie: 1, 2, 3 Examples:

[INPUT]: qn 3
[OUTPUT]: 
Question of flashcard index: 3
Learned?: [ ]
Question: What is a java interface?

interface Interface{
void method();
}

View answer only: ans

Show the answer of a flashcard via its index.

Format: ans INDEX INDEX must be a positive integer, ie: 1, 2, 3 Examples:

[INPUT]: ans 3
[OUTPUT]:
Answer of flashcard 3
Answer: Java

Edit question and answer: edit

Edit the question and answer of a flashcard via its index.

Format: edit INDEX /q QUESTION /a ANSWER INDEX must be a positive integer, ie: 1, 2, 3 Examples:

[INPUT]: edit 3 /q What is a java interface? /a a special class
[OUTPUT]: 
Updated flashcard
Edit Question: Old placeholder question here
   Updated Question: What is a java interface?
Edit Answer: Old placeholder answer here
   Updated Answer: a special class

Edit question only: edit

Edit the question of a flashcard via its index.

Format: edit INDEX /q QUESTION INDEX must be a positive integer, ie: 1, 2, 3 Examples:

[INPUT]: edit 3 /q What is a java interface?
[OUTPUT]: 
Updated flashcard
Edit Question: Old placeholder question here
   Updated Question: What is a java interface?
Edit Answer: Old placeholder answer here
   Updated Answer: Old placeholder answer here

Edit answer only: edit

Edit the answer of a flashcard via its index.

Format: edit INDEX /a ANSWER INDEX must be a positive integer, ie: 1, 2, 3 Examples:

[INPUT]: edit 3 /a a special class
[OUTPUT]: 
Updated flashcard
Edit Question: Old placeholder question here
   Updated Question: Old placeholder question here
Edit Answer: Old placeholder answer here
   Updated Answer: a special class

Insert code snippet: insert_code

Inserts code snippet of a flashcard via its index.

Format: insert_code INDEX /c CODE_SNIPPET INDEX must be a positive integer, ie: 1, 2, 3 Examples:

[INPUT]: insert_code 3 /c interface Interface{ void method(); }
[OUTPUT]: 
Inserted code snippet to flashcard.
Question: What is a java interface?
Answer: a special class
Code Snippet: 
interface Interface{ 
   void method(); 
}

Delete flashcard: delete

Delete the flashcard in the deck via its index

Format: delete INDEX INDEX must be a positive integer, ie: 1, 2, 3 Examples:

[INPUT]: delete 3
[OUTPUT]:
Deleted flashcard 3
Question: What language is used in CS2113?
Answer: Java

Quiz mode with timer: quiz

Enters quiz mode. The unlearned flashcards in the deck would be shuffled and the user would have to enter the correct answer for each flashcard. If the flashcard is answered correctly, it would be marked as learned, and the user would not see the flashcard again if they enter quiz mode afterwards. They can re-add the question by marking the flashcard as unlearned. After the quiz, they can type view_results to view their results and re-quiz the unlearned flashcards.

The user can type exit_quiz to exit the test mode, but the progress would not be saved.

Format: quiz Examples:

[INPUT]: quiz
[OUTPUT]: Entering quiz mode... get ready!
[OUTPUT]: You have 2 questions left:
[OUTPUT]: What language is used in CS2113?
[INPUT]: Java.
[OUTPUT]: Correct! Time elapsed: 10 seconds
[OUTPUT]: You have 1 question left:
[OUTPUT]: What colour is an apple?
[INPUT]: Blue.
[OUTPUT]: Incorrect. Time elapsed: 22 seconds
[OUTPUT]: You finished the test! You took: 22 seconds!
Type view_res to check your test result

Mark as learned: mark_learned

Marks the question as learned. Flashcards that are correctly answered in quiz mode would be automatically marked as learned. Learned flashcards are not tested again in quiz mode. Learned flashcards cannot be mark learned again.

Format: mark_learned INDEX INDEX must be a positive integer, i.e: 1, 2, 3

Examples:

[INPUT]:mark_learned 2
[OUTPUT]:Changed flashcard number 2 into learned

Unmark learned: mark_unlearned

Marks the flashcard as unlearned. Unlearned flashcards are tested in quiz mode. Unlearned flashcards cannot be marked unlearned again.

Format: mark_unlearned INDEX INDEX must be a positive integer, i.e: 1, 2, 3

Examples:

[INPUT]:mark_unlearned 2
[OUTPUT]: Changed flashcard number 2 into unlearned

View test results: view_res

Views the flashcards that were answered wrong after test mode. You can only view the test result after a test and you can only view it once.

Format: view_res

Examples:

[INPUT]: view_res
[OUTPUT]:
=== Quiz Results ===and......
- Total Question(s): 1
- Correct Answer(s): 1
- Incorrect Answer(s): 0
- Accuracy: 100.00%
- Grade: A+ :)

PERFECT SCORE! FLAWLESS PERFORMANCE!

   ,d88b.d88b,
   88888888888
   `Y8888888Y'
     `Y888Y'
       `Y'
   GOLD MEDAL

Great job! You have answered all of questions correctly.

This is the end of the test report.

Search Flashcards: search

Searches for the specified flashcard. If no deck is selected, the search will be across all decks. However, if a deck is selected, then the search will only be specific to that deck.

Format: search /q QUESTION /a ANSWER either /q or /a can be omitted if required. Non-case specific.

Examples:

[INPUT]: search /q What language is used in CS2113? /a Java
[OUTPUT]: 
Flashcards matched: 
Deck: CS2113
Question: What language is used in CS2113?
Answer: Java
[INPUT]: select CS2113
[INPUT]: search /q What language is used in CS2113?
[OUTPUT]: 
Flashcards matched: 
Question: What language is used in CS2113?
Answer: Java
[INPUT]: search /a java
[OUTPUT]: 
Flashcards matched: 
Question: What language is used in CS2113?
Answer: Java

Deck Features

Create a new deck: new

Creates a new deck with the given deck name. Deck name should not already be in use.

Format: new DECKNAME, DECKNAME cannot contain \ or /.
Examples:

  • new testDeck → Creates a new deck named testDeck (if the name is not already taken).

Select a Deck: select

Selects the specified deck via the index. There must be an available deck to select to use this command. You can view decks to select using the decks command.

Format: select INDEX

Examples:

  • select 1 → Selects the first deck.

Rename a Deck: rename

Renames the currently selected deck to a new name. A deck must be selected before using this command.

Format: rename NEWNAME, NEWNAME cannot contain \ or /.

Examples:

  • rename testDeck2 → Renames the current deck to testDeck2.

View All Decks: decks

Displays a list of all available decks.

Format: decks

Examples:

  • decks → Lists all existing decks.

Delete a Deck: remove

Deletes the specified deck. There will be a confirmation before deletion to prevent accidental deletion. The user can also view decks to delete using the decks command.

This action is permanent and cannot be undone.

Format: remove INDEX

Examples:

  • remove 2 → Deletes the second deck in the list.

Unselect a Deck: unselect

Unselects the specified deck. There must be a deck selected to use this command. This command does not take any arguments.

Format: unselect

Examples:

  • unselect → If deck "testDeck" is selected, this unselects "testDeck"

FAQ

Q: I have created many flashcards, will my data be saved?

A: Yes, your data will be saved to a txt file under ./data/decks/. Remember to use the exit command to save!

Q: How do I transfer my data to another computer?

A: It's easy, simply install FlashCLI using the instructions given in Quick Start. Then, overwrite the txt file(s) located in ./data/decks/ on the new computer.

Command Summary

Action Format, Examples
View User Guide user_guide
Create Flashcard add /q QUESTION /a ANSWER e.g. add /q What language is used in CS2113? /a Java
List Flashcards list
View Question qn INDEX e.g. qn 3
View Answer ans INDEX e.g. ans 3
Delete Flashcard delete INDEX e.g. delete 3
Edit Flashcard edit INDEX [/q QUESTION] [/a ANSWER] e.g. edit 2 /q What is substitutability? /a A method
Search Flashcard search /q QUESTION /a ANSWER e.g. search /q What language is used in CS2113? /a Java
New Deck new DECKNAME e.g. new testDeck
Select Deck select DECKNAME e.g. select testDeck
Rename Deck rename NEWNAME e.g. rename testDeck2
View Decks decks
Delete Deck remove DECKNAME e.g. remove testDeck
Unselect Deck unselect
Quiz Mode quiz
View Results view_results , redo
Code Snippet insert_code INDEX /c CODE_SNIPPET e.g. insert_code 3 /c interface Interface{ void method(); }
Mark Learned mark_learned INDEX e.g. mark_learned 2
Mark Unlearned mark_unlearned INDEX e.g. mark_unlearned 2
Exit exit