diff --git a/README.md b/README.md index 0c62e6b..5d8b8fa 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Generate PDF worksheets of simple math problems in the browser. -Inspired by the worksheets my dad printed off for my siblings and I during the summer breaks. I'm recreating this purely by memory; all I remember is that it was a grid of math problems, printed on a dot matrix printer. Not sure what he created his sheets in (likely QBasic or VisualBasic as this was late 1990s), so my attempt is to recreate this as close as possible, using modern web technologies. +Inspired by the worksheets my dad printed off for my siblings and I during the summer breaks. I'm recreating this purely by memory; all I remember is that it was a grid of math problems, printed on a dot matrix printer. Not sure how he created those sheets (likely Basic/QBasic or VisualBasic as this was late 1990s), so my attempt is to recreate this as close as possible, using modern web technologies. Built with HTML, CSS and Typescript and Vite in (more than) a few hours. I'm also using this as an exercise to learn newer web technologies (like TS and Vite). Is this overkill? Yes. Was it worth it? TBD (but likely yes). @@ -15,7 +15,7 @@ For generating the problems, there's several configuration options: - The two operand min/max values can be set independently - For division problems, the second operand is regenerated if it's 0 to avoid divide by zero problems - Set the number of problems to generate - - Currently I'm creating the PDF so that it fits 24 problems (4x6) per page, which may change + - Currently I'm creating the PDF so that it fits 20 problems (4x5) per page, which may change - Set the operand order (highest or lowest first) - Option to not have negative answers, which overrides operand order to highest first (helpful with subtraction problems) - Option to use long division notation in displaying problems @@ -23,13 +23,13 @@ For generating the problems, there's several configuration options: - If unselected, then answers are rounded to 3 decimal places where needed - Configuration options and resulting problems can be saved by using the same URL - When the problems are generated, you can click the `Save Config` button to rewrite the current URL with parameters that specify which options are set and their respective values - - When returning to the site with the same URL, the problems generated will be the same, handled by the `seed` value in the form. A different seed will generate different problems + - When returning to the site with the same URL and parameters, the problems generated will be the same, handled by the `seed` value in the form. A different seed will generate different problems - Throwback wallpaper! - Wallpaper is randomly chosen on first visit and reloads - The Select menu below the windows can change the background, saving the choice in localStorage for future visits -For generating the PDFs, there's a couple options to change: +When generating the PDFs, there's a couple options to change: - Set the font used in the generated PDF - If something fails, this will fall back to using the default Courier font @@ -39,17 +39,13 @@ For generating the PDFs, there's a couple options to change: ## Status -It's at the MVP stage right now with basic functionality available. +The web app is at the MVP stage right now, with basic functionality available. -There are a couple features still in-progress: - -- Allow multiple operators, instead of one or all - -See [ISSUES](https://github.com/sphars/math-sheets/issues) for details about upcoming features. +See [ISSUES](https://github.com/sphars/math-sheets/issues) for details about potential features. ## Development -This site is built with Typescript and Vite. Only requirement is Node v22+. To run locally, clone the repo, then +This site is built with Typescript and Vite. Node v22+ is required. To run locally, clone the repo, then ``` cd math-sheets diff --git a/index.html b/index.html index db83272..dd8a9a6 100644 --- a/index.html +++ b/index.html @@ -41,8 +41,10 @@ in the late 90s/early 00s (hence the Windows 98 theme). Thanks Dad!

- This website is open-source and is licensed under the MIT license. Have any comments or bugs to report? File - an issue on GitHub. + This website is open-source and is licensed under the MIT license. + Source code. Have any comments or bugs + to report? File an issue on + GitHub.