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

Changed to class-based generators

Browse Source
This commit is contained in:
lukew3
2020-10-13 12:42:38 -04:00
parent 4196e245f3
commit 0effa0c3a7
2 changed files with 42 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@@ -5,7 +5,17 @@ This project was created with contributions at it's core. We need your help to e
## How You Can Help
### Coding Generators
As of right now, all of our generators are being coded in python. Each generator should be contained in a function. Your function should look something like the following:
As of right now, all of our generators are being coded in python. Your generator will be an object of the Generator class and will have a function created seperately.
Your object instantiation should follow this format:
```
#g<id> = Generator("<Title>", <id>, <generalized problem>, <generalized solution>, <function name>)
```
and look something like this:
```
g2 = Generator("Addition", 2, "a+b=", "c", addition)
```
Your function should look something like the following:
```
def addition(maxSum, maxAddend):
"""
@@ -25,6 +35,7 @@ def addition(maxSum, maxAddend):
solution = str(c)
return problem, solution
```
Before coding, please check README.md to see if someone has already created the generator you plan to make.
Skillid is determined by the next available id as can be determined in the table.