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