diff --git a/.gitignore b/.gitignore index db2b97b..b9c8fd9 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,6 @@ data/db.json *.pdf *.png *.log + +# keep documentation screenshots +!docs/screenshots/*.png diff --git a/README.md b/README.md index 681e1fd..4cefcfb 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,26 @@ You stay in control: every question can be edited, regenerated with a steering n --- +## Screenshots + +**Create** — paste, upload, or pull from a URL, then set parameters and generate. + +![Create an assignment](docs/screenshots/create.png) + +**Library** — every assignment you've made, stored locally on your machine. + +![Library](docs/screenshots/library.png) + +**Editor** — per-question editing with `✓ Verified` / `⚠ Check this` accuracy badges and source quotes. + +![Question editor](docs/screenshots/editor.png) + +**Settings** — pick your AI provider (local or cloud) and set your school profile. + +![Settings](docs/screenshots/settings.png) + +--- + ## What you need - **Docker** — [Docker Desktop](https://www.docker.com/products/docker-desktop/) on macOS/Windows, or Docker Engine on Linux. That's the only thing you install. diff --git a/docs/screenshots/create.png b/docs/screenshots/create.png new file mode 100644 index 0000000..1168253 Binary files /dev/null and b/docs/screenshots/create.png differ diff --git a/docs/screenshots/editor.png b/docs/screenshots/editor.png new file mode 100644 index 0000000..63f8989 Binary files /dev/null and b/docs/screenshots/editor.png differ diff --git a/docs/screenshots/library.png b/docs/screenshots/library.png new file mode 100644 index 0000000..bc1d0c8 Binary files /dev/null and b/docs/screenshots/library.png differ diff --git a/docs/screenshots/settings.png b/docs/screenshots/settings.png new file mode 100644 index 0000000..f271a1f Binary files /dev/null and b/docs/screenshots/settings.png differ