Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/orxonox/branches/chris/README @ 1994

Last change on this file since 1994 was 1896, checked in by patrick, 21 years ago

orxonox/trunk: added ability to shoot. so check out the new release and shoot the fuck up

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