Initial ASK question data

README.md

@@ -0,0 +1,88 @@
+# ASK-Machen
+
+Repozytorium zawiera bazę pytań do quizu ASK-Machen.
+
+W repozytorium znajdują się dane quizu: `pytania.txt` oraz opcjonalnie katalog `img/` z obrazkami używanymi w pytaniach. Kod aplikacji nie jest częścią tego repozytorium.
+
+## Jak zgłaszać poprawki
+
+Poprawki zgłaszamy przez Pull Request.
+
+Logowanie w systemie nie wymaga weryfikacji e-mail. Można podać dowolne dane; system jest w pełni anonimowy.
+
+Najczęstsze dobre zmiany:
+
+- poprawienie literówki,
+- oznaczenie prawidłowej odpowiedzi jako `-|`,
+- usunięcie błędnej odpowiedzi,
+- dopisanie źródła w komentarzu `//`,
+- dodanie brakującego obrazka do `img/`.
+
+Nie zmieniaj formatu pliku na pełny Markdown, JSON, CSV ani HTML. To repozytorium używa prostego formatu QAML opisanego niżej.
+
+## QAML
+
+QAML, czyli Question Answer Markdown Lines, to prosty liniowy format zapisu pytań testowych wielokrotnego wyboru.
+
+Parser interpretuje wyłącznie początki linii:
+
+- linia pytania,
+- linia odpowiedzi błędnej,
+- linia odpowiedzi poprawnej,
+- komentarz,
+- pusta linia.
+
+Treść pytania i odpowiedzi może zawierać Markdown, HTML oraz inline LaTeX, ale parser traktuje je jako zwykły tekst.
+
+## Minimalny przykład
+
+```text
+// Przykładowa sekcja
+
+Zaznacz zdania prawdziwe
+- To jest odpowiedź błędna.
+-| To jest odpowiedź poprawna.
+- To jest kolejna odpowiedź błędna.
+```
+
+## Reguły składni
+
+### Pytanie
+
+Pytaniem jest każda niepusta linia, która nie zaczyna się od `-` ani `//`.
+
+Pytanie musi mieścić się w jednej linii.
+
+### Odpowiedź błędna
+
+Odpowiedź błędna zaczyna się od pojedynczego myślnika `-`.
+
+```text
+- Odpowiedź błędna
+-Odpowiedź błędna
+```
+
+### Odpowiedź poprawna
+
+Odpowiedź poprawna zaczyna się od `-|`.
+
+```text
+-| Odpowiedź poprawna
+-|Odpowiedź poprawna
+```
+
+### Liczba poprawnych odpowiedzi
+
+Format dopuszcza dowolną liczbę poprawnych odpowiedzi, w tym zero poprawnych odpowiedzi albo wszystkie odpowiedzi poprawne.
+
+### HTML i obrazki
+
+HTML jest dopuszczony jako część treści pytania lub odpowiedzi.
+
+Jeżeli `pytania.txt` odwołuje się do obrazka przez `img/...`, plik musi istnieć w katalogu `img/` w tym repozytorium.
+
+## Walidacja lokalna
+
+```bash
+php tools/validate_qaml.php pytania.txt
+```