Skip to content

Commit

Permalink
Update UserGuide.md with grammarly check
Browse files Browse the repository at this point in the history
  • Loading branch information
Andy123qq4 authored Apr 14, 2024
1 parent 5ed37d1 commit 44737de
Showing 1 changed file with 28 additions and 25 deletions.
53 changes: 28 additions & 25 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@
1. [Introduction](#introduction)
2. [Get Started](#get-started)
3. [Features and Commands](#features-and-commands)
1. [Show Help Intructions](#show-help-instructions-help)
2. [Generate Problem Set](#generate-problem-set-generate)
1. [Show Help Instructions: `help`](#show-help-instructions-help)
2. [Generate Problem Set: `generate`](#generate-problem-set-generate)
3. [Autosaving/Loading Past Attempts](#autosavingloading-past-attempts)
4. [View Past Records](#view-past-records-records)
4. [View Past Records: `records`](#view-past-records-records)
5. [Submit Answer](#submit-answer-enterreturn)
6. [Judge Answer](#judge-answer)
7. [Create DIY Problem Sets](#create-diy-problem-sets-diy)
8. [Retry Previous Problem Sets](#retry-previous-problem-sets-retry)
9. [Exit](#exit-exit)
7. [Create DIY Problem Sets: `DIY`](#create-diy-problem-sets-diy)
8. [Retry Previous Problem Sets: `retry`](#retry-previous-problem-sets-retry)
9. [Exit: `exit`](#exit-exit)
10. [Command Summary](#command-summary)
4. [Interaction guide](#interaction-guide)
4. [FAQ](#faq)
1. [Interaction Guide](#interaction-guide)
5. [Final Words](#final-words)

## Introduction
Expand All @@ -34,7 +35,7 @@ java mathGenius.java

### Show help instructions: `help`

For a comprehensive list of all possible commands and their usage, run the `help` command: It lists out the **command you can use** and the **standard input format** (e.g. input should be in fraction or in decimal form).
For a comprehensive list of all possible commands and their usage, run the `help` command: It lists out the **command you can use** and the **standard input format** (e.g., input should be in fraction or in decimal form).

**Format:** `help COMMAND_NAME`
- The `COMMAND_NAME` can be commands like `generate`, `records`, `exit`
Expand All @@ -46,7 +47,7 @@ For a comprehensive list of all possible commands and their usage, run the `help
help exit
```
### Generate problem set: `generate`
Generate the problem based on series of parameters. For example, what operators you wish to include in the set **`+ - * /`**, the number of problems in the set etc. And as you enter the answer in order, the program will auto check your answers for correction.
Generate the problem based on a series of parameters. For example, what operators do you wish to include in the set **`+ - * /`**, the number of problems in the set, etc. As you enter the answers in order, the program will auto-check your answers for correction.

**Format:** `generate -t OPERATOR -n NUMBER_OF_PROBLEMS -d MAXIMUM_DIGITS -l LENGTH_OF_EQUATION`

Expand All @@ -64,13 +65,13 @@ Generate the problem based on series of parameters. For example, what operators

### Autosaving/Loading past attempts

Each time you finish a problem set, you results will be automatically stored in an external file `recordList.txt`. And each time you restart the application, the data from the file will be automatically loaded.
Each time you finish a problem set, your results will be automatically stored in an external file `recordList.txt`. Each time you restart the application, the data from the file will be automatically loaded.

Please **do not** manually change the file unless you're sure of what you're doing(Improper editing of the file could lead to data corruption/loss).

### View past records: `records`

View the records of your past problem solving sessions. Each record information including the date the problem set was solved, the time spent(in seconds) to solve the problem set, and the accuracy(measured in percentage), as well as the details of the problem set(including the problem set's unique ID, and each individual problem if you desire so).
View the records of your past problem-solving sessions. Each record information including the date the problem set was solved, the time spent(in seconds) to solve the problem set, and the accuracy(measured in percentage), as well as the details of the problem set(including the problem set's unique ID, and each individual problem if you desire so).

**Format:** `records -SORT_BY_DATE -SORT_BY_SPEED -SORT_BY_ACCURACY -SORT_BY_PROBLEM_SET_ID -SHOW_DETAILS`

Expand All @@ -87,7 +88,7 @@ type the answer in the terminal and press ENTER/RETURN

### Judge Answer:

After finishing all the problem sets, the program will automate judged the correctness and output the accuracy and speed.
After finishing all the problem sets, the program will automatically judge the correctness and output the accuracy and speed.

### Create DIY Problem Sets: `DIY`

Expand All @@ -96,32 +97,32 @@ Add user DIY problem sets into our problem set datasets. The DIY problem set can
**Format:** `DIY`

- after inputting `DIY`:
1. System will output
1. The system will output
`Please input your DIY problemSet:
input the description of the problem (e.g. 1+2*3): `
user can input a user-defined problem into the system.
2. Then the System will ask for input:
`input the correct answer of the problem (e.g. 7): `
user should input the correct answer of the user-defined problem.
user should input the correct answer to the user-defined problem.
3. Then the System will ask:
`Have you finished adding problems? y/n: `
if user input `y`, which means no more problems will be added.
if user input `n`, the system will repeat step 1 to 3 until user input `y`.
- user can see the type of the problem set, i.e. user - DIY or auto generated, in the records.
if the user inputs `y`, which means no more problems will be added.
if the user inputs `n`, the system will repeat steps 1 to 3 until the user inputs `y`.
- The user can see the type of the problem set, i.e., user-DIY or auto-generated, in the records.

### Retry previous problem sets: `retry`

Allows users to try a problem set that they have attempted before in the past, meaning problem sets that are within the list of `records` can be attempted by copying the *problem set ID*, which is generated when users first attempt the problem set. For how to locate the problem set ID you wish to retry, check out the **View past records** section of the UserGuide.
Allows users to try a problem set that they have attempted before in the past, meaning problem sets within the list of `records` can be attempted by copying the *problem set ID*, generated when users first attempt the problem set. For how to locate the problem set ID you wish to retry, check out the **View past records** section of the UserGuide.

All retry attempts will also be saved in the records through the auto-saving feature, and will use the same Problem set ID in the new record as well. This means users can easily filter through all their attempts of one particular problem set through the `records` feature
All retry attempts will also be saved in the records through the auto-saving feature, and will use the same Problem set ID in the new record as well. This means users can easily filter through all their attempts at one particular problem set through the `records` feature

**Format:** `retry PROBLEM_SET_ID`

- PROBLEM_SET_ID is an signed integer number, which can be found by using the `records` command
- PROBLEM_SET_ID is a signed integer number, which can be found by using the `records` command

### Exit: `exit`

User can use this to exit the program.
Users can use this to exit the program.

**Format:** `exit`

Expand All @@ -130,7 +131,7 @@ Here are some example commands you can use in **MathGenius**:

Here are some example commands you can try:
1. `generate`: generate problem set (with specific parameters )
2. Pressing `Enter/Return`: Submits your answer to a problem.
2. Pressing `Enter/Return`: Submit your answer to a problem.
3. `exit`: Exits the program.
4. `records`: Displays your past problem-solving sessions, including the date you finished the set, your speed, accuracy, and the details of the problems.
5. `DIY`: Add user DIY problem sets into our problem set datasets. The DIY problem set can also be saved and retried.
Expand All @@ -150,9 +151,11 @@ Remember, practice makes perfect. Happy learning with **MathGenius**!
| `retry` | Retry a problem set that you've attempted in the past(through ID in records) | `retry -PROBLEM_SET_ID` | `retry 17462645` |
| `exit` | Exit the program | `exit` | `exit` |

## Interaction Guide
## FAQ

You may wonder what is the input format for every questions, e.g. + - * /, or even decimals, here we provided a detailed guide for you!
### Interaction Guide

You may wonder about the input format for every question, e.g., + - * /, or even decimals. Here, we provide a detailed guide for you!

### *Infinite Decimal Answers*

Expand All @@ -164,4 +167,4 @@ Our program is designed to check answers with a tolerance up to the hundredth pl

## Final Words

Remember, the goal of **MathGenius** is to help you improve your math skills. Don't worry too much about the precision of your answers. Focus on understanding the concepts and improving your problem-solving speed and accuracy.
Remember, the goal of **MathGenius** is to help you improve your math skills. Please don't worry too much about the accuracy of your answers. Focus on understanding the concepts and improving your problem-solving speed and accuracy.

0 comments on commit 44737de

Please sign in to comment.