Mercurial > clickerconvert
changeset 8:24d547e7ea09
Add README
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Tue, 22 Mar 2016 15:22:44 +0100 |
parents | afb1ecf0f1db |
children | 997e8b31f19d |
files | README |
diffstat | 1 files changed, 63 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Tue Mar 22 15:22:44 2016 +0100 @@ -0,0 +1,63 @@ +ClickerConvert +============== + +Copyright (C) 2016 by ETH Zürich +Software engineering by Intevation GmbH + +This file is Free Software under the GNU GPL (v>=2) +and comes with ABSOLUTELY NO WARRANTY! +See LICENSE.txt for details. + + +Introduction +------------ + +Clicker convert converts the text output of a classromm response system +("clicker") to other doucment formats. Currently only xlsx is supported. + +The orignal target platforms are Windows NT > 6.1 (Seven and later) and +GNU/Linux and MacOS. + +Input File Format +----------------- +The input file is a text document with the following expected properties: + +Questions: + - A Question is defined by last unquoted string before a line starting + with "Answer" + - A multiple choice Answer are all strings that match the pattern + "\"(.*)\",(\\d+),(\\d+\\.\\d+)" in all lines following a line + "Answer,Votes,Percent" before the next Question. + - A free text answer is a Quoted string following a Question and + the single line "Answer". + All text before the next question is interpreted as free text responses. + If a Quoted string is inside an Answer it is combined with that Answer. + + See constants.h for definition. + +Usage +----- + +See clickerconvert --help + +Installation +------------ +See the file INSTALL for build instructions. + +Binaries may be available on the project homepage. + + +Documentation +------------- +The documentation is written as part of Doxygen comments. + +Contact +------- +For additional information or custom modifications please contact: + + Intevation GmbH <intevation@intevation.de> + Neuer Graben 17 + 49074 Osnabrück, Germany + +The public development platform can be found at: +https://wald.intevation.org/projects/clickerconvert/