From 1beda4777c22e46f86a0dfa7c2abc03134085ca4 Mon Sep 17 00:00:00 2001 From: Richard Lobb Date: Mon, 2 Aug 2021 19:54:22 +1200 Subject: [PATCH] Update README --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 3e07950..1340129 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # ucquestiontypes Selected University of Canterbury CodeRunner question types plus support files. + +## Contents +Each folder contains an xml export of a question type (i.e. a prototype) +plus the various support files it uses and its template file. +You should be able to simply import the xml file into the question bank. +The support files and the template are within it and are available +separately only for convenience in editing, updating and viewing. + +Instructions for using the various question types are, as usual, within the prototype. +You can either edit the prototype file to read the Question text (which is the documentation) +or create a new question of that type and expand the *Show details* section. + +Warning: it is quite possible that the support files will be updated more regularly +than the xml export. So if you want to guarantee to have the latest version, please +first check the date of the export (which is within the filename) and compare with +the modification dates on the support files. Replace any updated support files +within the prototype. + +## Disclaimer +This repository is primarily for in-house use by the University of Canterbury +but anyone else if of course welcome to use the question types. If you need +support you can try posting to the CodeRunner question author's forum, but +please realise that these question types are not a supported part of +CodeRunner itself, so no support is guaranteed.