deadvey/mathgenerator
1
0
Fork 0
mirror of https://github.com/DeaDvey/mathgenerator.git synced 2025-11-28 06:25:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update readme to remove mathgen

Browse Source
This commit is contained in:
lukew3
2022-12-19 14:11:56 -05:00
parent 8e264e6b23
commit 13fdefd53c
2 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -30,13 +30,13 @@ pip install mathgenerator
Here is an example of how you would generate an addition problem:
```python
from mathgenerator import mathgen
import mathgenerator
#generate an addition problem
problem, solution = mathgen.addition()
problem, solution = mathgenerator.addition()
#another way to generate an addition problem using genById()
problem, solution = mathgen.genById(0)
problem, solution = mathgenerator.genById(0)
```
<!--
### Creating a worksheet
@@ -55,8 +55,8 @@ ws.write_pdf()
This creates the pdf `ws.pdf` in your current directory
-->
Problem/solution pairs are generated with either:
* `mathgen.<generator_name>()` - generates a problem, solution set from the given generator name.
* `mathgen.genById(id)` - generates a problem, solution set with generator id provided by the `id` parameter
* `mathgenerator.<generator_name>()` - generates a problem, solution set from the given generator name.
* `mathgenerator.genById(id)` - generates a problem, solution set with generator id provided by the `id` parameter
<!--
#### `format` kwarg

1
mathgenerator/__init__.py
View File

@@ -4,7 +4,6 @@ from .generator import getGenList
genList = getGenList()
# || Non-generator Functions
def genById(id, *args, **kwargs):
generator = genList[id][2]
return (generator(*args, **kwargs))