mirror of
https://github.com/DeaDvey/mathgenerator.git
synced 2025-11-28 06:25:23 +01:00
readme edits
This commit is contained in:
20
README.md
20
README.md
@@ -1,15 +1,29 @@
|
|||||||
# mathgenerator
|
# mathgenerator
|
||||||
A math problem generator, created for the purpose of giving self-studying students and teaching organizations the means to easily get access to random math problems to suit their needs.
|
A math problem generator, created for the purpose of giving self-studying students and teaching organizations the means to easily get access to random math problems to suit their needs.
|
||||||
|
|
||||||
To try out generators, go to http://todarith.ml/generate
|
To try out generators, go to https://todarith.ml/generate/
|
||||||
|
|
||||||
|
If you have an idea for a generator, please add it as an issue and tag it with the "New Generator" label.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
The project can be install via pip
|
||||||
|
```
|
||||||
|
pip install mathgenerator
|
||||||
|
```
|
||||||
|
Here is an example of how you would generate an addition problem:
|
||||||
|
```
|
||||||
|
from mathgenerator import mathgen
|
||||||
|
|
||||||
|
#generate an addition problem
|
||||||
|
problem, solution = mathgen.addition()
|
||||||
|
```
|
||||||
## List of Generators
|
## List of Generators
|
||||||
|
|
||||||
| Id | Skill | Example problem | Example Solution | Function Name | Status |
|
| Id | Skill | Example problem | Example Solution | Function Name | Status |
|
||||||
|------|----------------------------|-----------------|-------------------|----------------|-------------|
|
|------|----------------------------|-----------------|-------------------|----------------|-------------|
|
||||||
| 2 | Addition | 1+5= | 6 | addition | Complete |
|
| 2 | Addition | 1+5= | 6 | addition | Complete |
|
||||||
| 3 | Subtraction | 9-4= | 5 | subtraction | Complete |
|
| 3 | Subtraction | 9-4= | 5 | subtraction | Complete |
|
||||||
| 4 | Multiplication | 4*6= | 24 | | In Progress |
|
| 4 | Multiplication | 4*6= | 24 | | Not Started |
|
||||||
| 5 | Division | 4/2= | 2 | | In Progress |
|
| 5 | Division | 4/2= | 2 | | Not Started |
|
||||||
| - | Factoring | x^2+x-6 | (x-2)(x+3) | | Not Started |
|
| - | Factoring | x^2+x-6 | (x-2)(x+3) | | Not Started |
|
||||||
| - | Power Rule Differentiation | x^5 | 5x^4 | | Not Started |
|
| - | Power Rule Differentiation | x^5 | 5x^4 | | Not Started |
|
||||||
|
|||||||
Reference in New Issue
Block a user