mirror of
https://github.com/DeaDvey/mathgenerator.git
synced 2025-11-28 06:25:23 +01:00
Update readme to remove mathgen
This commit is contained in:
10
README.md
10
README.md
@@ -30,13 +30,13 @@ pip install mathgenerator
|
|||||||
Here is an example of how you would generate an addition problem:
|
Here is an example of how you would generate an addition problem:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from mathgenerator import mathgen
|
import mathgenerator
|
||||||
|
|
||||||
#generate an addition problem
|
#generate an addition problem
|
||||||
problem, solution = mathgen.addition()
|
problem, solution = mathgenerator.addition()
|
||||||
|
|
||||||
#another way to generate an addition problem using genById()
|
#another way to generate an addition problem using genById()
|
||||||
problem, solution = mathgen.genById(0)
|
problem, solution = mathgenerator.genById(0)
|
||||||
```
|
```
|
||||||
<!--
|
<!--
|
||||||
### Creating a worksheet
|
### Creating a worksheet
|
||||||
@@ -55,8 +55,8 @@ ws.write_pdf()
|
|||||||
This creates the pdf `ws.pdf` in your current directory
|
This creates the pdf `ws.pdf` in your current directory
|
||||||
-->
|
-->
|
||||||
Problem/solution pairs are generated with either:
|
Problem/solution pairs are generated with either:
|
||||||
* `mathgen.<generator_name>()` - generates a problem, solution set from the given generator name.
|
* `mathgenerator.<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.genById(id)` - generates a problem, solution set with generator id provided by the `id` parameter
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
#### `format` kwarg
|
#### `format` kwarg
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ from .generator import getGenList
|
|||||||
genList = getGenList()
|
genList = getGenList()
|
||||||
|
|
||||||
|
|
||||||
# || Non-generator Functions
|
|
||||||
def genById(id, *args, **kwargs):
|
def genById(id, *args, **kwargs):
|
||||||
generator = genList[id][2]
|
generator = genList[id][2]
|
||||||
return (generator(*args, **kwargs))
|
return (generator(*args, **kwargs))
|
||||||
|
|||||||
Reference in New Issue
Block a user