Mercurial > clickerconvert
comparison README @ 8:24d547e7ea09
Add README
| author | Andre Heinecke <andre.heinecke@intevation.de> |
|---|---|
| date | Tue, 22 Mar 2016 15:22:44 +0100 |
| parents | |
| children | b574990e90a5 |
comparison
equal
deleted
inserted
replaced
| 7:afb1ecf0f1db | 8:24d547e7ea09 |
|---|---|
| 1 ClickerConvert | |
| 2 ============== | |
| 3 | |
| 4 Copyright (C) 2016 by ETH Zürich | |
| 5 Software engineering by Intevation GmbH | |
| 6 | |
| 7 This file is Free Software under the GNU GPL (v>=2) | |
| 8 and comes with ABSOLUTELY NO WARRANTY! | |
| 9 See LICENSE.txt for details. | |
| 10 | |
| 11 | |
| 12 Introduction | |
| 13 ------------ | |
| 14 | |
| 15 Clicker convert converts the text output of a classromm response system | |
| 16 ("clicker") to other doucment formats. Currently only xlsx is supported. | |
| 17 | |
| 18 The orignal target platforms are Windows NT > 6.1 (Seven and later) and | |
| 19 GNU/Linux and MacOS. | |
| 20 | |
| 21 Input File Format | |
| 22 ----------------- | |
| 23 The input file is a text document with the following expected properties: | |
| 24 | |
| 25 Questions: | |
| 26 - A Question is defined by last unquoted string before a line starting | |
| 27 with "Answer" | |
| 28 - A multiple choice Answer are all strings that match the pattern | |
| 29 "\"(.*)\",(\\d+),(\\d+\\.\\d+)" in all lines following a line | |
| 30 "Answer,Votes,Percent" before the next Question. | |
| 31 - A free text answer is a Quoted string following a Question and | |
| 32 the single line "Answer". | |
| 33 All text before the next question is interpreted as free text responses. | |
| 34 If a Quoted string is inside an Answer it is combined with that Answer. | |
| 35 | |
| 36 See constants.h for definition. | |
| 37 | |
| 38 Usage | |
| 39 ----- | |
| 40 | |
| 41 See clickerconvert --help | |
| 42 | |
| 43 Installation | |
| 44 ------------ | |
| 45 See the file INSTALL for build instructions. | |
| 46 | |
| 47 Binaries may be available on the project homepage. | |
| 48 | |
| 49 | |
| 50 Documentation | |
| 51 ------------- | |
| 52 The documentation is written as part of Doxygen comments. | |
| 53 | |
| 54 Contact | |
| 55 ------- | |
| 56 For additional information or custom modifications please contact: | |
| 57 | |
| 58 Intevation GmbH <intevation@intevation.de> | |
| 59 Neuer Graben 17 | |
| 60 49074 Osnabrück, Germany | |
| 61 | |
| 62 The public development platform can be found at: | |
| 63 https://wald.intevation.org/projects/clickerconvert/ |