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