diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41fcd76..ae41d84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,8 +5,8 @@ This project wouldn't be possible without the generosity of contributors like yo ## How You Can Help * Add a generator idea to github issues. * Fix bugs in existing generators. Check out the issues tab of the Github to see what bugs exist and need to be fixed. -* Write a generator. Follow the pattern in [the template](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template.py) and the [template with comments](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template_comments.py). Make sure to place your generator function into the correct subject folder of `mathgenerator/funcs/`. After you are finished, run `adoptGenerator.py` inside the `scripts` directory to update the README and `__init__.py` file. -* Improve demo/documentation site. The source code for the mathgenerator website is in the `gh-pages` branch. Let me know what changes you propose in the issues tab. +* Write a generator. Write a function that generates a problem string and solution string. Use latex formatting for math, with `$` being on either side of latex expressions. Then, add a tuple `(, )` to the `mathgenerator/_gen_list.py` file. Follow the pattern in [the template](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template.py) and the [template with comments](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template_comments.py). +* Improve demo/documentation site. The source code for the mathgenerator website is in the `demo` branch. If you find something else that you'd like to work on, leave an issue or make a pr, and I'll be sure to review it!