From aa02091df08f2bbe8d65ef5b3c58b568c62ab53f Mon Sep 17 00:00:00 2001 From: glendc Date: Thu, 8 Feb 2024 12:43:28 +0100 Subject: [PATCH] add padding + title + README info --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ site/1/mathbox.html | 4 ++++ site/index.html | 4 ++-- 3 files changed, 48 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 61e7c9e..55b4259 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,44 @@ # homework + Free online playground to practice homework. + +Of course you can also use it within a class setting or anywhere really. Naming is hard. + +The goal of this tool is not to replace personal guidance, teachers or parents. It is a tool +that you should use just as you would use pen and paper. Ideally you can sit with your +child and be there for them as guidance. + +## Developers + +Homework is available at for free as a static website, +static as in purely client-side. Each exercise page is its own program that is developed +independently. + +Please note that we are not going for the most clever or best designed code in this project. +Obviously we do not want to aim for obsecurity either, but the aim is first and foremost to +have exercises that are good enough for our kids to be able to practise. + +### Run + +```bash +python -m http.server -d site 8080 +``` + +or run it more easily using [just](https://just.systems/): + +```bash +just +``` + +which does the same, but less typing for you. + +### Contributing + +Please consult [the CONTRIBUTING docs](./CONTRIBUTING.md) and [the Code of Conduct doc](CODE_OF_CONDUCT.md) for more information. + +For now this website and its exercises are only in Dutch (NL-BE), but we aim to support other languages somewhere in near future. +No promises though. + +While I don't expect any security issues, given it all runs as fairly dum client-only widgets on your own machine, +there is always a possibility in this very overly complex world. As such, should you notice any security issues, +of any severity or kind, you can find more info on what to do with that [in the SECURITY doc](./SECURITY.md). diff --git a/site/1/mathbox.html b/site/1/mathbox.html index 85d23c0..1bc7204 100644 --- a/site/1/mathbox.html +++ b/site/1/mathbox.html @@ -17,6 +17,10 @@