Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/README @ 10270

Last change on this file since 10270 was 10013, checked in by patrick, 18 years ago

merged the collision reaction branche back to trunk

File size: 4.2 KB
Line 
1
2
3This is the offical README file for the game project
4
5--------------------------------------------------------
6                       orxOnox
7--------------------------------------------------------
8
91.Preface:
10----------
11Orxonox is a open-source vertical scroller game programed
12in c++ and OpenGL.
13If we manage to be sober enough, this game shall definitly
14become _the_ open-source vertical scroller ever.
15
162.Manifesto:
17------------
181) Alien is a great film
192) Guiness is the most delicious beer
203) If you think there is anything missing specialy in terms of story: you can be shure it's an arcade game
214) Wanna chill: ask Boozoo Bajou
22
23to be continoued...
24
25
263.Overview:
27---------
281.Preface
292.Manifesto
303.Overview
313.Contributing To The Project
324.Howto C++ Programming
335.Howto SVN
346.Coding conventions
35
36
374.Contributing To The project:
38------------------------------
39People who want to help us working on orxonox are always
40welcome:) Feel free to chip in anything you like. Wine, beer,
41coffee... If you like to help us programming orxonox, you:
42- join the developer community mailing lists
43- read this README file
44then you have multiple ways to get started.
45a) Read the hole source code and choose a topic you like
46b) check the TODO file to get a knowledge of what we need
47c) ask us for more information
48To get more informations about programming and project specs
49read the programming sections below.
50
51To start programming on orxonox you first have to download the
52newest svn tree of orxonox. You can do this by enterning following
53lines in the linux console (ensure svn to be installed with ssl
54support enabled):
55
56svn co https://svn.orxonox.net/reporx/orxonox orxonox
57
58If you haven't got ssl support in you svn tool, recompile it
59./configure --with-ssl
60make
61make install
62
63
645.Howto C++ Programming:
65------------------------
66If you are new to c/c++ programming, this project is probably
67not the best starting place to learn it. For you and the rest who
68need "refreshment" check out these guides:
69
70www.cplusplus.com/doc/tutorial
71www.4p8.com/eric.brasseur/cppcen.html
72
73
746.Howto SVN:
75------------
76For a more complete guide about this topic read the documentation
77avaiable at subversion.tigris.org.
78
79SVN (=subversion) is a version control program similar to CVS but
80newer. This program enables us to work all at the same program at
81the same time - tricky.
82
83subversion checkout https://svn.orxonox.net/reporx/orxonox orxonox
84same as: subversion co https://svn.orxonox.net.....
85
86this makes a directory orxonox at your current place in and gets
87the hole brand new source code from the server.
88
89now you can work. Remember to use 'svn copy instead of 'cp',
90'svn mv' instead of 'mv', 'svn rm' instead of 'rm'... - you got it
91I think.
92After you have made your changes to the files enter
93svn status
94or with more details: svn status -vv
95which will show you the changes you did locally on your computer.
96svn diff
97is similar but shows you all the changes in detail.
98
99svn diff > patchfile
100the patchfile you can use later in conjunction with the patch program.
101You could, for example, email this patchfile to another developer for
102review or testing prior to commit.
103
104To add a new file type
105svn add <filename>
106and to publish all your changes type
107svn commit --message "Corrected number of chees slices."
108svn commit will send all of your changs to the repository. When you
109commit a change, you need to supply a log message, describing your
110change. The message can also be read from a file:
111svn commit --file logmsg
112
113If you accidently make a change you like to revert, you just can do this
114by typing:
115svn revert <filename>
116
117To keep track about the work that is running on the project use the
118command: svn log. This will show you a bref summary of all changes.
119
120
121Most of the programmer will do their work on a branch. A Branch is
122a line of development that exists independently of another line, yet
123still shares a common history. A branch always begins life as a copy
124of something, and moves on trom there, generating its own history. Later
125the two versions will merge.
126
127If you are working on orxonox you will have your own branch in which you
128will program, some sort of sand-box. If you finish your work on your
129topic, it will be revised by us and merged with the trunk
130
1317.Coding Conventions
132--------------------
133Read the File CODING-STANDARDS
134
135
136#EOF
Note: See TracBrowser for help on using the repository browser.