From e3c906fdf4a155ecd35596b4a75e16ddb7dd5a70 Mon Sep 17 00:00:00 2001 From: Luke Weiler Date: Mon, 19 Dec 2022 02:44:03 -0500 Subject: [PATCH] Update README.md --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e43baaa..69a3391 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ The project can be install via pip pip install mathgenerator ``` -## Basic Usage +## Usage Here is an example of how you would generate an addition problem: ```python @@ -56,15 +56,14 @@ ws.write_pdf() ``` 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 -* `getGenList()` returns 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]` -* `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 ## algebra