Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/README @ 9819

Last change on this file since 9819 was 9406, checked in by bensch, 18 years ago

orxonox/trunk: merged the proxy back

merged with commandsvn merge -r9346:HEAD https://svn.orxonox.net/orxonox/branches/proxy .

no conflicts

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