Debian Codegraph @

README

raw
1 Welcome
2 -------
3 Welcome to ClanLib, a multi-platform game development library.
4
5
6 Getting started
7 ---------------
8 PLEASE! Please read the INSTALL files for the platform/compiler you want to use.
9 See INSTALL.win32, INSTALL.linux, INSTALL.borland, INSTALL.whatever.
10
11
12 Upgrading from earlier ClanLib versions
13 ---------------------------------------
14 If you are upgrading your ClanLib project from earlier ClanLib versions, read the
15 file README.upgrade for API changes. The NEWS file will have some details on
16 what was upgraded, fixed and added in this specific version.
17
18
19 Documentation
20 -------------
21 If you get any problems, there is a FAQ in the Documentation folder; it might have
22 an answer to your questions. Otherwise, read the overviews for specific info on
23 the various areas of ClanLib.
24
25 Examples: Many small examples showing features of ClanLib.
26 Documentation/Overview: Articles about certain features of ClanLib.
27 Documentation/Reference: The complete API reference to all ClanLib classes.
28 Documentation/Tutorial: Some tutorials about game programming with ClanLib.
29 Documentation/FAQ: Frequently asked/answered questions.
30
31 YOU ARE NOT SUPPOSED TO READ THE XML FILES, THEY MUST BE CONVERTED TO HTML!
32 (OR JUST READ THEM ONLINE ON CLANLIB.ORG)
33
34 If you are using Windows, and haven't got the tools required to build the
35 documentation, or the distribution of ClanLib you have don't have a Documentation
36 folder, you can manually download the documentation packages from
37 http://clanlib.org/download.html. Also, all documentation is available
38 for viewing online at http://clanlib.org/docs.html
39
40
41 Forum
42 -------------
43 If you need to search for questions, or have a question yourself,
44 visit our forum at http://www.rtsoft.com/clanlib
45
46
47 IRC
48 ---
49 Our official IRC channel is located at irc.freenode.net, channel #clanlib.
50 Drop by to meet fellow ClanLibbers and developers!
51
52
53 Making ClanLib even better
54 --------------------------
55 We are grateful for all the help we can get, and if you wish to contribute with
56 anything, don't hesitate to contact us.
57
58 If you have fixed something in ClanLib, you can send us a patch. Please have a
59 look at the PATCHES file for more detailed information.
60
61 If you have discovered a bug, please tell us about it in the forum.
62
63 A developer's reference is available. This contains all the internal classes for
64 ClanLib which are useful for ClanLib developers. To enable the reference, go in
65 to the Documentation/Reference directory and run 'make dev_ref'. Note that you
66 need the same tools as described in the section Documentation to make this.
67
68
69 ClanLib Website
70 ---------------
71 Check out ClanLib homepage at:
72
73 http://www.clanlib.org
74
75 --
76 Enjoy,
77 The ClanLib development team