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.md

Browse Source
This commit is contained in:
Luke Weiler
2022-12-19 02:44:03 -05:00
committed by GitHub
parent c603edb698
commit e3c906fdf4
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -28,7 +28,7 @@ The project can be install via pip
pip install mathgenerator pip install mathgenerator
``` ```
## Basic Usage ## Usage
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
@@ -56,15 +56,14 @@ ws.write_pdf()
``` ```
This creates the pdf `ws.pdf` in your current directory This creates the pdf `ws.pdf` in your current directory
--> -->
`genById(id)` generates a problem, solution set with generator id `id` in the format `[problem, solution]`
#### `format` kwarg
* Pass `format=latex` to return problem and solution set as latex. If latex is not available for that generator, the problem will return the string "Latex unavailable"
* Pass `format=raw` to return just the raw data for each generator. An array of each variable necessary to the generator is returned.
* If you don't pass a value to the format kwarg, the generator will return a problem and answer in asciimath format.
## Documentation You can also use `getGenList()` to return a list of all generators in the repository in the format `[id, title, self, funcname, subjectname]`
* `getGenList()` returns a list of all generators in the repository in the format `[id, title, self, funcname, subjectname]`
* `genById(id)` generates a problem, solution set with generator id `id` in the format `[problem, solution]`
* Pass the kwarg `format=latex` to return problem and solution set as latex. If latex is not available for that generator, the problem will return the string "Latex unavailable"
* Pass the kwarg `format=raw` to return just the raw data for each generator. An array of each variable necessary to the generator is returned.
## List of Generators ## List of Generators
## algebra ## algebra