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:52:33 -05:00
committed by GitHub
parent e3c906fdf4
commit 09a82d242a
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -8,9 +8,7 @@ See [CONTRIBUTING.md](https://github.com/lukew3/mathgenerator/blob/main/CONTRIBU
## Table of Contents ## Table of Contents
* [Installation](#installation) * [Installation](#installation)
* [Basic Usage](#basic-usage) * [Usage](#usage)
* [More Complicated Usage](#more-complicated-usage)
* [Documentation](#documentation)
* [List of Generators](#list-of-generators) * [List of Generators](#list-of-generators)
* [algebra](#algebra) * [algebra](#algebra)
* [basic_math](#basic_math) * [basic_math](#basic_math)
@@ -56,12 +54,16 @@ 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]` 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 `id` in the format `[problem, solution]`
<!--
#### `format` kwarg #### `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=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. * 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. * If you don't pass a value to the format kwarg, the generator will return a problem and answer in asciimath format.
-->
You can also use `getGenList()` to return a list of all generators in the repository in the format `[id, title, self, funcname, subjectname]` You can also use `getGenList()` to return a list of all generators in the repository in the format `[id, title, self, funcname, subjectname]`