diff --git a/README.md b/README.md index 5cb34b0bdd384797595bb702ccea2a73005a1ba3..e4d202cdc6712940893b4c84301590f62e6d6afa 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ This is a new implementation of [Hektor](https://gitlab.gwdg.de/j.michal/hektor) It can be used to convert the ILIAS output of an e-exam into a json format which can be imported into the [Grady](https://gitlab.gwdg.de/j.michal/grady) project. -The idea is, that in the future this tool will allow to take the export outputs generated by ILIAS in the various formats and transform them into a json representation, that contains all the relevant information. - ## Download @@ -18,16 +16,20 @@ View the help message: rusty-hektor -h ``` -Convert an ILIAS `.xls` import into `.json`: +Convert an ILIAS `.xls` or `.zip` containing `.xml` import into `.json`: ``` -rusty-hektor <path_to_xls> <out_file_path> +rusty-hektor -o <out_file_path> <path_to_(xls|xml)> ``` Converting an ILIAS Output into an anonymised json representation, storing the mapping file at `map.csv` (DO NOT LOOSE THIS FILE!). ``` -rusty-hektor -a --map-file map.csv <path_to_xls> <out_file_path> +rusty-hektor -a --map-file map.csv -o <out_file_path> <path_to_(xls|xml)> ``` +If the `-o` is omitted, the the output is printed to stdout. + +If you call the program with the paths to an `.xml` and `.xls` export, both will be read and compared for inconsistencies. + ### Word List The anonymised names are generated by selecting random words from the EFF long list, intended for password generation.