annotate README @ 66:098a10fc2e83 0.9.2

Add doxygen files and improve doxygen comments
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 21 May 2015 15:21:47 +0200
parents 3acafcfc52a1
children
rev   line source
63
3acafcfc52a1 Document bundle creation
Andre Heinecke <andre.heinecke@intevation.de>
parents: 29
diff changeset
1 RetraceIT
3acafcfc52a1 Document bundle creation
Andre Heinecke <andre.heinecke@intevation.de>
parents: 29
diff changeset
2 =========
29
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
3
66
098a10fc2e83 Add doxygen files and improve doxygen comments
Andre Heinecke <andre.heinecke@intevation.de>
parents: 63
diff changeset
4 Copyright (C) 2015 by ETH Zürich
29
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
5 Software engineering by Intevation GmbH
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
6
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
7 This file is Free Software under the GNU GPL (v>=2)
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
8 and comes with ABSOLUTELY NO WARRANTY!
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
9 See LICENSE.txt for details.
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
10
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
11
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
12 Introduction
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
13 ------------
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
14
63
3acafcfc52a1 Document bundle creation
Andre Heinecke <andre.heinecke@intevation.de>
parents: 29
diff changeset
15 RetraceIT is a tool to view recorded login sessions. The record data
29
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
16 consists of a metadata.csv file that cotains additional information
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
17 and serveral screenshots (taken with user consent) of the recorded
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
18 session.
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
19
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
20 The orignal target platforms are Windows NT > 6.1 (Seven and later) and
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
21 GNU/Linux and MacOS.
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
22
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
23 Installation
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
24 ------------
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
25 See the file INSTALL for build instructions.
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
26
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
27 Binaries may be available on the project homepage.
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
28
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
29
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
30 Documentation
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
31 -------------
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
32 The documentation is written as part of Doxygen comments.
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
33
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
34 Building the documentation is not yet implemented.
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
35
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
36 Contact
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
37 -------
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
38 For additional information or custom modifications please contact:
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
39
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
40 Intevation GmbH <intevation@intevation.de>
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
41 Neuer Graben 17
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
42 49074 Osnabrück, Germany
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
43
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
44 The public development platform can be found at:
c2aec2f33928 Add readme with some basic information.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
45 https://wald.intevation.org/projects/retraceit/
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)