Skip to content

Commit

Permalink
add padding + title + README info
Browse files Browse the repository at this point in the history
  • Loading branch information
glendc committed Feb 8, 2024
1 parent 04b5cf5 commit aa02091
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <https://elementary.training> 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).
4 changes: 4 additions & 0 deletions site/1/mathbox.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
<link rel="stylesheet" href="/css/reset.css">

<style>
body {
padding-inline: 10px;
}

main {
max-width: 800px;
margin-inline: auto;
Expand Down
4 changes: 2 additions & 2 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<style>
body {
font-size: 1.5 em;
padding-inline: 10px;
}

main {
Expand All @@ -38,7 +38,7 @@

<body>
<main>
<h1>Huiswerk 🏫</h1>
<h1>Oefeningen Basisschool 🏫</h1>
<p>
Deze website is bedoeld voor leerlingen van de basisschool.
Hier kunnen ze oefenen gebruikmakende van willeurige oefeningen
Expand Down

0 comments on commit aa02091

Please sign in to comment.