| | 1 | = Orxonox Primer = |
| | 2 | ei all! |
| | 3 | |
| | 4 | this is a little tutorial for all new to orxonox, for all other a little |
| | 5 | refresh: |
| | 6 | |
| | 7 | == 1. Maillists == |
| | 8 | we got 3 major mailing lists: [[br]] |
| | 9 | '''orxonox-dev at mail.datacore.ch''' : development stuff just for us [[br]] |
| | 10 | '''orxonox-announce at mail.datacore.ch''' : annonucements to all who like orx [[br]] |
| | 11 | '''orxonox-commit at mail.datacore.ch''' : auto-mail if svn repos changes [[br]] |
| | 12 | |
| | 13 | |
| | 14 | == 2. Webpage == |
| | 15 | we've got two web pages: [[br]] |
| | 16 | [http://www.orxonox.ethz.ch The Main Page]: this page is for all that want some quick infos [[br]] |
| | 17 | [https://www.orxonox.ethz.ch/cgi-bin/trac.cgi/wiki This Wiki]: wiki for developers, to work more interactive [[br]] |
| | 18 | |
| | 19 | The wiki got some nice features like the ticket system: there you can set up development requests. the roadmap shows you what the current development goals are. Anyone with a account/pass (all developers) is able to make changes to the wiki or the ticket system, just use the account from the subversion. |
| | 20 | |
| | 21 | |
| | 22 | == 3. Repository == |
| | 23 | Orxonox is been programmed by many programmers at the same time (at the moment, we are 7 programmers). to synchronize the work and to make it available for all, we got a central subversion server (subversion is a newer form of cvs). most linux got svn (subversion) in their software repository (gentoo: portage tree, debian: apt-system) windows needs special software, that you can get from: http://tortoisesvn.tigris.org/ If you want to read more about this topic, you will find more infos in: |
| | 24 | * [http://svnbook.red-bean.com/en/1.1/index.html the official subversion guide, written very funny] |
| | 25 | * [http://www.onlamp.com/pub/a/onlamp/2002/10/31/subversion.html a shorter version] |
| | 26 | you can download the repos in linux by typing: |
| | 27 | {{{ |
| | 28 | valisk $ svn co "https://svn.orxonox.ethz.ch/reporx/orxonox" orxonox |
| | 29 | }}} |
| | 30 | |
| | 31 | == 4. Compiling and Running == |
| | 32 | to get orx running on your system, read the following articles: [wiki:Running Get it Running]. |
| | 33 | |
| | 34 | |
| | 35 | == 5. Chat, IRC == |
| | 36 | you will find us normaly on our irc-channel on: '''irc://irc.datacore.ch ''', channel: '''#orxonox'''. there we talk about orx, development issues or anything else... |
| | 37 | |
| | 38 | |
| | 39 | == 6. Mailaliases == |
| | 40 | we are maintaining a mail server. if possible, we normaly register for every user peter muster following email adresses: |
| | 41 | * peter at orxonox.ethz.ch |
| | 42 | * peter.muster at orxonox.ethz.ch |
| | 43 | * muster at orxonox.ethz.ch |
| | 44 | and forward them to your email account or to a localy mailbox on the server, that you will be able to check out via imap |
| | 45 | |
| | 46 | |
| | 47 | == 7. Webpage Stats: == |
| | 48 | we have installed a graph, that monitors the current web traffic on our server. we keep track about visits/hits on our website. you find it in: |
| | 49 | * [http://www.orxonox.ethz.ch/awstat/awstats.pl?config=www.orxonox.ethz.ch awstat on orxonox server] |
| | 50 | you will have to log in with your account (subversion/wiki) |
| | 51 | |
| | 52 | |
| | 53 | == 8. Finding your Way as a Developer == |
| | 54 | As a developer of orxonox (coder/modler) you will want to communicate over our mailinglists, the wiki and the irc. You will find the current tasks, for the next orxonox release under: |
| | 55 | * [https://www.orxonox.ethz.ch/cgi-bin/trac.cgi/roadmap Roadmap] |
| | 56 | and all tasks, that we have defined yet: |
| | 57 | * [https://www.orxonox.ethz.ch/cgi-bin/trac.cgi/report/1 Tasks] |
| | 58 | You will see the current changes on the orxonox source and the wiki on |
| | 59 | the timline of our wiki: |
| | 60 | * [https://www.orxonox.ethz.ch/cgi-bin/trac.cgi/timeline timeline] |
| | 61 | the commit messages will also be sent to your email adress, if you have registered to the orxonox-commit mailinglist |
| | 62 | |
| | 63 | |
| | 64 | == 9. Understanding Orxonox == |
| | 65 | This will definitly take some time to understand the orxonox. The best way to get your questions answered is to post them on the development-mailinglist. Even better is just to go the the developers and ask them to give you an overview... Once you know where to find which functions, you will want to read more about special topics in the sourcefiles itself: we use doxygen to comment the code, there you will find a comment to every class/function. There is a second source of information, that we are currently working |
| | 66 | on: [wiki:ModulesDescription module description] |
| | 67 | |
