summaryrefslogtreecommitdiff
path: root/ARMFCaptureD3D/ConfigFile/README
blob: 27406cfe8cf708368e3d375017f3fbdd6501f7d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
README for ConfigFile distribution
Richard J. Wagner  v2.1  24 May 2004

Instructions
------------

The only necessary files for using this configuration file reader are
"ConfigFile.h" and "ConfigFile.cpp".  The class name is ConfigFile.

Usage examples are in "example.cpp".  Linux or Unix users can type "make" to
compile and then type "make run" to run the example program.

The test program in "tester.cpp" will check that the class properly reads
a variety of simple and complex configuration file entries.  To run the test
program type "make test".

When you are done with the examples and the test program, type "make clean"
to get rid of temporary files.

For Windows or Mac users with a compiler such as Metrowerks CodeWarrior or
Microsoft Visual C++, simply add "example.cpp" and "ConfigFile.cpp" to an
empty C++ console application.  Compile and run to see the configuration
file reader in action.  Do likewise with "tester.cpp" to check that the
code works properly with your compiler.

If you encounter any problems, please e-mail a copy of the output and a
description of the test system to me at "wagnerr@umich.edu".  Any other
feedback is welcome too.


Installation
------------

Just copy the files "ConfigFile.h" and "ConfigFile.cpp" to your working
directory or some other place where your compiler can find them.  Add
"ConfigFile.cpp" to your project and put the following line at the top of
your program to access the ConfigFile class:

#include "ConfigFile.h"


Contents
--------

README            - this file
ConfigFile.h      - declaration of ConfigFile class
ConfigFile.cpp    - definitions of ConfigFile class
example.cpp       - examples of using ConfigFile
tester.cpp        - tests ConfigFile class
example.inp       - configuration file for example program
test.inp          - configuration file for tester program
Triplet.h         - sample user-defined data type
Makefile          - instructions used by "make" command
ConfigFile.html   - Web page about ConfigFile
AntBlueMaize.jpg  - background for ConfigFile.html
ArrowHome.gif     - home icon for ConfigFile.html
main.css          - style sheet for ConfigFile.html