Update README.md

README.md

@@ -6,4 +6,39 @@ language:
 pretty_name: VIK Wiki quiz
 size_categories:
 - 1K<n<10K
----
+---
+# VIK Wiki quiz
+
+## Leírás
+
+VIK wikiről scrapelt kikérdező parsolva, `.jsonl` formátumban.
+A scrapelést/parsolást végző kód a itt a repo-ban megtalálható.
+
+## Cél
+
+Én elsősorban LLM-ek tanításra/kiértékelésre gondoltam.
+
+## Adatforrás
+
+Minden [VIK wiki](wiki.sch.bme.hu) kikérdező.
+
+## Mezők
+
+- `title`: a két `==` közötti szövegrész. Szinte mindig meg van adva. Általában ez tartalmazza magát a kérdést.
+- `question`: a `title` és a `{{Kvízkérdés...}}` közti rész. Általában üres. Több kontextust adhat a címhez.
+- `answers`: a `#`-el kezdődő sorok. A lehetséges válaszok.
+- `correct_answers`: a helyes válaszok indexe (1-től). Mindig szám lista.
+- `type`: a kikérdező típusa, tehát hogy checkboxos/többválasztós (multi) vagy radiobuttonos/egyválaszos (single).
+- `score`: pontozás típusa. Általában üres, néha `-` (pontlevonás), illetve még `+` lehet.
+- `quiz_title`: a kvíz címe, amiből a kérdés származik.
+- `url`: a kvíz url-je, amiből a kérdés származik.
+- `file`: van, hogy a kérdéshez kép is tartozik, ebben az esetben ez a mező tartalmazza a képet.
+
+## Adatminőség
+
+Nagyrészt jó, de lehetnek benne elgépelések/hibák.
+Ezen kívül még további szövegtisztításra szorul.
+
+## Köszönetnyilvánítás
+
+Nagy köszönet a wikit fenntartó HAT-nak és a kvizeket szerkesztő hallgatóknak, nélkülük ez az adathalmaz nem jöhetett volna létre.