Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/orxonox/trunk/README @ 5029

Last change on this file since 5029 was 4944, checked in by bensch, 19 years ago

orxonox/trunk: opened and saved some files, and also rewritten some organizatory stuff

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