1Atlas-C++
2
3Welcome to Atlas-C++, the C++ reference implementation of the Atlas protocol.
4
5This library implements the Atlas protocol, for use in client-server
6game applications.  This library is suitable for linking to either
7clients or servers.
8
9VERSION
10
11This is Atlas-C++ 0.4.9x, the latest transitional incarnation of Atlas-C++ as
12of 2003-08-03. The 0.4.9x branch will contains the same API as the 0.4.x
13stable series, but method names have been converted to lower case. The
14intention is that developers can port their code to this series as a first
15step towards porting to 0.5.x series. The 0.5.x
16branch is completely experimental and may not be easy to track. Any
17changes affecting the API should go into 0.5.x, as should any features
18which are not completely stable. 0.6.0 will be the next stable branch.
19
20PREREQUISITES
21
22Atlas-C++ has been compiled on a number of different compilers including:
23
24Microsoft Visual C++
25egcs 2.91.66
26gcc 2.95.2
27gcc 2.96 (provided many older Redhat releases)
28gcc 3.0
29gcc 3.1
30gcc 3.2
31gcc 3.3
32
33Previous versions of Atlas-C++ would not build on many compilers, including
34specifically egcs and Visial C++. This is no longer true of this version.
35
36COMPILING
37
38For details of how to compile Atlas-C++ see INSTALL. Please note that
39optimisation has been enabled by default for the Atlas-C++ build.
40Atlas-C++ builds extremely slowly on some older compilers
41if optimisation is enabled, and on such compilers it is recommended that
42on slower systems binaries are built non-optimised.
43
44To disable optimisation set the following environment variable before
45running the configure script.
46
47	CXXFLAGS=""
48
49This overrides that default compiler flags, which include -O2.
50
51SOCKET LIBRARIES
52
53Atlas-C++ relies on iostreams being used as socket streams for network
54communications. This means you will need to either use an existing library
55or use your own.
56
57One such a library is skstream, which is maintained by the worldforge
58project, and can be downloaded from:
59
60ftp://ftp.worldforge.org/pub/worldforge/libs/skstream/
61
62This library works on many platforms including Windows, and is derived from
63the FreeSockets library by Rafael Guterres Jeffman.
64
65DOCUMENTATION
66
67To generate the documentation, simply configure the tree, then in Atlas-C++/
68type "make docs". This will use doxygen to generate the documentation, which
69will then reside in Atlas-C++/doc/.
70
71Please read the file HACKING carefully before working on Atlas-C++.
72
73LICENSING
74
75Atlas-C++ is licensed under the GNU Lesser General Public License. Please see
76the file COPYING for details as to its distribution.
77
78Atlas-C++ is provided AS IS with ABSOLUTELY NO WARRANTY. Please see the file
79COPYING for details.
80
81CONTACT
82
83Please see the AUTHORS file for contact information.
84