From 61c13b6b5b2a62193beaef39749befac38d18ad1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A1t=C3=A9=20Gy=C3=B6ngy=C3=B6si?=
 <gyongyosimate1@gmail.com>
Date: Tue, 4 Jun 2024 20:18:11 +0200
Subject: [PATCH] =?UTF-8?q?=E2=9E=95=20Added=20explanation=20of=20paramete?=
 =?UTF-8?q?rs;=20added=20example=20and=20warnings?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 8fef2db..ef5a6e9 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,22 @@ A program for converting a graded Moodle quiz saved as an HTML file to a [vik.vi
 moodle-to-vikwikiquiz [--verbose|-v] [[--grading|-g] grading_method] [[--output|-o] destination_file] source_directory parent_article title
 ```
 
+Parameters:
+* `grading_method`: `+` or `-`. See https://vik.wiki/wiki/Segítség:Kvíz#Pontozás for further info.
+* `destination_file`: The name of the file where the wikitext quiz should be exported to. Use `.txt` as the extension.
+* `source_directory`: The directory where the Moodle quiz HTML files are located. The review page of the quizzes should be downloaded.
+* `parent_article`: The article name of the course on [vik.wiki](https://vik.wiki/).
+* `title`: How the quiz should be named on [vik.wiki](https://vik.wiki/). This usually is in the following form: `[course name] kvíz – [exam name]`.
+
+Example:
+* Convert all *Elektronika alapjai* Moodle quizzes downloaded to `~/Downloads/downloaded_ELA_quizzes`:
+```bash
+moodle-to-vikwikiquiz --grading - ~/Downloads/downloaded_ELA_quizzes "Elektronika alapjai" "Elektronika alapjai kvíz – vizsga"
+```
+
+Always check the output before uploading it to [vik.wiki](https://vik.wiki/). 
+Upload all images and add their filenames to the quiz manually on [vik.wiki](https://vik.wiki/).
+
 ## 📜 License
 
 This project is licensed under the _GNU General Public License v3.0_.