Graduately/README.md

# maturita.c

Vzdělávací GTK 4 aplikace k přípravě na maturitu. / An educational GTK 4 app for the Czech maturita exam.

**[Česky](#česky)** · **[English](#english)**

---

## Česky

Rozhraní je v češtině a angličtině. Hotové jsou čtyři předměty; ostatní jsou
zatím zamčené placeholdery. Aplikace se po instalaci aktualizuje sama.

| Úvod | Předměty | Německá cesta |
| ---- | -------- | ------------- |
| ![Úvod](assets/welcomescreen.png) | ![Předměty](assets/subjectsscreen.png) | ![Německá cesta](assets/germanlection.png) |

### Instalace

Žádné releasy ani čísla verzí nejsou. CI po každém pushi na `main` uloží
balíčky do větve [`builds`](https://github.com/pepaskopec-blip/maturita.c/tree/builds).
Instalátor samotnou aplikaci neobsahuje — při spuštění si stáhne aktuální
build, takže soubor nikdy nezestárne.

**Nejjednodušší je instalátor pro vaši platformu:**

| Platforma | Soubor | Jak spustit |
| --------- | ------ | ----------- |
| macOS (Apple Silicon) | [maturita-installer-macos.zip](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-installer-macos.zip) | Rozbalit, pravý klik → **Otevřít** |
| Windows (x64) | [maturita-installer-windows.cmd](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-installer-windows.cmd) | Dvojklik; u SmartScreenu **Další informace → Přesto spustit** |
| Linux (x86_64) | [maturita-installer-linux.sh](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-installer-linux.sh) | `sh maturita-installer-linux.sh` |

Kam se to nainstaluje: `/Applications` nebo `~/Applications` (macOS),
`%LOCALAPPDATA%\Programs\Maturita` (Windows), `~/Applications` (Linux).

Buildy nejsou podepsané, proto je při **prvním** spuštění potřeba výše uvedený
krok navíc. Aplikace se pak udržuje sama: po startu porovná svůj commit se
souborem `VERSION` ve větvi `builds` a aktualizaci nabídne v pruhu nahoře.
Ruční kontrola je v **Nastavení → Aktualizace**.

#### Bez instalátoru

Na stejné větvi jsou i hotové balíčky:

- [maturita-macos-arm64.zip](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-macos-arm64.zip)
- [maturita-windows-x64.zip](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-windows-x64.zip)
- [maturita-linux-x86_64.AppImage](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-linux-x86_64.AppImage)

Postup a nastavení se ukládají vedle `.app` / složky / AppImage do `progress/`.

Intel Mac, jiná architektura nebo úpravy kódu → [sestavení ze zdroje](#sestavení-ze-zdroje).

### Co v aplikaci je

- **Deutsch** — 3 otevřené jednotky (Neue Freunde, Aus aller Welt, Bei uns zu
  Hause): cvičení, nápovědy, vokabeltraining
- **Správa počítačových sítí** — 1. ročník, 27 lekcí (VLSM + teorie a kvízy);
  ročníky 2–4 jsou zamčené
- **Technické vybavení** — 3 lekce (architektura, historie, bit/byte)
- **Český jazyk a literatura** — mluvnice (20 cvičení) a maturitní četba
  (1984, Spalovač mrtvol); literatura je zatím zamčená
- statistiky, 10 témat, tmavý/světlý režim, čeština/angličtina
- ukončení: `Cmd/Super+Q` nebo `Alt+F4`

### Použití

1. **Pokračuj** otevře mapu předmětů.
2. Otevřený předmět (vlajka, Wi‑Fi, čip, česká vlajka) vede na učební cestu.
3. Uzly cvičení / lekcí otevřou obsah; zamčené nic nedělají.
4. **Statistiky** (graf) a **Nastavení** (ozubené kolo) jsou vpravo nahoře.

### Sestavení ze zdroje

```bash
# macOS
brew install gtk4 gcc make pkg-config

# Debian / Ubuntu
sudo apt install build-essential pkg-config libgtk-4-dev

# Fedora
sudo dnf install gcc make pkgconf-pkg-config gtk4-devel

# Arch
sudo pacman -S base-devel pkgconf gtk4
```

```bash
git clone https://github.com/pepaskopec-blip/maturita.c.git
cd maturita.c
make
make run          # nebo ./maturita
make bundle       # AppImage / .app zip / Windows složka s DLL
```

Volitelně CMake: `cmake -S . -B build && cmake --build build`.

#### Windows (MSYS2 UCRT64, bez Visual Studia)

```cmd
winget install --id MSYS2.MSYS2 -e --source winget
C:\msys64\ucrt64.exe pacman -S --noconfirm mingw-w64-ucrt-x86_64-gcc mingw-w64-ucrt-x86_64-gtk4 mingw-w64-ucrt-x86_64-pkg-config make
```

V terminálu **MSYS2 UCRT64**:

```bash
cd /c/Users/Josef/maturita.c    # C:\Users\Josef\maturita.c → /c/Users/Josef/maturita.c
make
./maturita.exe
make bundle                     # dist/maturita.exe jde spustit i z Průzkumníka
```

### Struktura

```
*.c / maturita.h     zdroj aplikace
style.css            GTK styl (barvy se vkládají za běhu)
installers/          instalátory, které stáhnou aktuální build
scripts/             balení AppImage a .app
.github/workflows/build.yml    CI: push na main → větev builds
assets/              ikona a screenshoty
progress/            vzniká za běhu (cvičení, nastavení)
```

Licence: [GPL-3.0](LICENSE).

---

## English

The UI is Czech and English. Four subjects are playable; the rest are locked
placeholders. After install the app updates itself.

| Welcome | Subjects | German path |
| ------- | -------- | ----------- |
| ![Welcome](assets/welcomescreen.png) | ![Subjects](assets/subjectsscreen.png) | ![German path](assets/germanlection.png) |

### Install

There are no releases and no version numbers. CI writes packages to the
[`builds`](https://github.com/pepaskopec-blip/maturita.c/tree/builds) branch
whenever `main` changes. The installer carries no app of its own — it fetches
the current build when you run it, so the file never goes stale.

**Start with the installer for your platform:**

| Platform | File | How to run |
| -------- | ---- | ---------- |
| macOS (Apple Silicon) | [maturita-installer-macos.zip](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-installer-macos.zip) | Unzip, then right-click → **Open** |
| Windows (x64) | [maturita-installer-windows.cmd](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-installer-windows.cmd) | Double-click; if SmartScreen appears, **More info → Run anyway** |
| Linux (x86_64) | [maturita-installer-linux.sh](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-installer-linux.sh) | `sh maturita-installer-linux.sh` |

Install locations: `/Applications` or `~/Applications` (macOS),
`%LOCALAPPDATA%\Programs\Maturita` (Windows), `~/Applications` (Linux).

The builds are unsigned, so the first launch needs the extra step above.
After that the app stays current: it compares its commit to `VERSION` on
`builds` and offers an update in a banner. Manual check:
**Settings → Updates**.

#### Packages without the installer

- [maturita-macos-arm64.zip](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-macos-arm64.zip)
- [maturita-windows-x64.zip](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-windows-x64.zip)
- [maturita-linux-x86_64.AppImage](https://github.com/pepaskopec-blip/maturita.c/raw/builds/maturita-linux-x86_64.AppImage)

Progress and settings live in `progress/` next to the `.app` / folder /
AppImage.

Intel Mac, another architecture, or hacking on the code →
[build from source](#build-from-source).

### What’s inside

- **Deutsch** — 3 open units (Neue Freunde, Aus aller Welt, Bei uns zu Hause):
  exercises, hints, vocabulary training
- **Computer networks** — year 1, 27 lessons (VLSM + theory/quizzes);
  years 2–4 are locked
- **Computer hardware** — 3 lessons (architecture, history, bit/byte)
- **Czech language** — grammar (20 exercises) and required reading
  (1984, Spalovač mrtvol); literature theory is still locked
- statistics, 10 palettes, dark/light mode, Czech/English
- quit with `Cmd/Super+Q` or `Alt+F4`

### Usage

1. **Continue** opens the subject map.
2. An open subject (flag, Wi‑Fi, chip, Czech flag) opens its path.
3. Exercise / lesson nodes open content; locked nodes do nothing.
4. **Statistics** (chart) and **Settings** (gear) sit in the top-right.

### Build from source

```bash
# macOS
brew install gtk4 gcc make pkg-config

# Debian / Ubuntu
sudo apt install build-essential pkg-config libgtk-4-dev

# Fedora
sudo dnf install gcc make pkgconf-pkg-config gtk4-devel

# Arch
sudo pacman -S base-devel pkgconf gtk4
```

```bash
git clone https://github.com/pepaskopec-blip/maturita.c.git
cd maturita.c
make
make run          # or ./maturita
make bundle       # AppImage / .app zip / Windows DLL folder
```

Optional CMake: `cmake -S . -B build && cmake --build build`.

#### Windows (MSYS2 UCRT64, no Visual Studio)

```cmd
winget install --id MSYS2.MSYS2 -e --source winget
C:\msys64\ucrt64.exe pacman -S --noconfirm mingw-w64-ucrt-x86_64-gcc mingw-w64-ucrt-x86_64-gtk4 mingw-w64-ucrt-x86_64-pkg-config make
```

In an **MSYS2 UCRT64** terminal:

```bash
cd /c/Users/Josef/maturita.c    # C:\Users\Josef\maturita.c → /c/Users/Josef/maturita.c
make
./maturita.exe
make bundle                     # dist/maturita.exe can be double-clicked
```

### Layout

```
*.c / maturita.h     application sources
style.css            GTK stylesheet (palette injected at runtime)
installers/          fetch-the-latest installers
scripts/             AppImage / .app bundlers
.github/workflows/build.yml    CI: push to main → builds branch
assets/              icon and screenshots
progress/            created at runtime (exercises, settings)
```

License: [GPL-3.0](LICENSE).