Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 18 and Version 19 of dev/Primer


Ignore:
Timestamp:
Oct 26, 2006, 9:36:52 AM (18 years ago)
Author:
simon
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • dev/Primer

    v18 v19  
    55This is a little tutorial for all new to Orxonox, a little refresh for all others:
    66
    7 == 1. Maillists ==
     7== 1. Mail lists ==
    88We've got 3 major mailing lists: [[br]]
    99  * [mailto:orxonox-dev@mail.datacore.ch orxonox-dev]     [https://mail.datacore.ch/mailman/listinfo/orxonox-dev subscribe] :    development stuff just for us
    … …  
    1414== 2. Webpage ==
    1515We've got two web pages: [[br]]
    16 [http://www.orxonox.net The Main Page]: This page is for all that want some quick infos [[br]]
    17 [https://www.orxonox.net/cgi-bin/trac.cgi/wiki This Wiki]: Wiki for developers, to work more interactive [[br]]
     16[http://www.orxonox.net The Main Page]: This page is for all who want some quick infos [[br]]
     17[https://www.orxonox.net/cgi-bin/trac.cgi/wiki This Wiki]: The Wiki page for developers to support interactive work [[br]]
    1818
    19 The wiki has got some nice features like the ticket system, where you can set up development requests. The roadmap shows 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.
     19The wiki has got some nice features like the ticket system, where you can set up development requests. The roadmap shows what the current development goals are. Anyone with a account / password (all developers) is able to make changes to the wiki or the ticket system; just by using the account from the subversion system.
    2020
    2121
    2222== 3. Forum ==
    23 There is also a forum: https://www.orxonox.net/forum/ - we use it to exchange thoughts, drawings, materials, whatever. You will have to create your name there from then on, you will be able to post there.
     23There is also a forum: https://www.orxonox.net/forum/ - we use it to exchange thoughts, drawings, materials, whatever. You will have to create a new account to be able to post there.
    2424
    2525
    2626== 4. Chat, IRC ==
    27 You will find us normally on our irc-channel on: '''irc://irc.datacore.ch ''', channel: '''#orxonox'''. there we talk about Orxonox, development issues or something else...
     27You will normally find some of us on our irc-channel on: '''irc://irc.datacore.ch ''', channel: '''#orxonox'''. there we talk about Orxonox, development issues or something else...
    2828
    2929
    30 == 5. Mailaliases ==
     30== 5. Mail aliases ==
    3131We are maintaining a mail server. If possible we register the following addresses for someone called Peter Muster:
    3232* peter at orxonox.ethz.ch
    3333* peter.muster at orxonox.ethz.ch
    3434* muster at orxonox.ethz.ch
    35 and forward them to your email account or to a local mailbox on the server, that you will be able to check out via imap.
     35and forward them to your email account or to a local mailbox on the server that you are able to check out via imap.
    3636
    3737
    … …  
    3939We 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:
    4040* [https://www.orxonox.net/awstat/awstats.pl?config=www.orxonox.net awstat on orxonox server]
    41 You have to log in with your account (subversion/wiki).
     41You have to log in with your subversion account.
    4242
    4343
    4444== 7. Repository ==
    45 Orxonox is being 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've got a central subversion server (subversion is a newer form of cvs). Most Linuxes have 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/ [[br]]
    46 If you want to read more about this topic, you will find more infos at:
     45Orxonox is programmed by many programmers at the same time. To synchronize the work and to make it available for all, we've got a central subversion server (subversion is a versioning system; the newer form of cvs). Most Linuxes already have svn (subversion) in their software repository (gentoo: portage tree, debian: apt-system), for Windows you need to install tortoise svn, which you can get here: http://tortoisesvn.tigris.org/ [[br]]
     46If you want to read more about this topic, go to:
    4747* [http://svnbook.red-bean.com/en/1.1/index.html the official subversion guide, written very funnily]
    4848* [http://www.onlamp.com/pub/a/onlamp/2002/10/31/subversion.html a shorter version]
    49 You can download the code repos in linux by typing:
     49You can download the code repositories in Linux by typing:
    5050{{{
    51 valisk $ svn co https://svn.orxonox.net/orxonox orxonox
     51yourcomputer $ svn co https://svn.orxonox.net/orxonox orxonox
    5252}}}
    5353and the data repository (ships, textures, pictures, sounds, etc):
    5454{{{
    55 valisk $ svn co https://svn.orxonox.net/data/ data
     55yourcomputer $ svn co https://svn.orxonox.net/data/ data
    5656}}}
    5757
    5858
    5959== 8. Compiling and Running ==
    60 To get Orxonox running on your system, first read the following articles: [wiki:Running Get it Running].
     60To get Orxonox running on your system, first read the following articles: [wiki:Running How to get Orxonox running].
    6161
    6262
    6363== 9. Finding your Way as a Developer ==
    64 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:
     64As a developer of Orxonox 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:
    6565 * [https://www.orxonox.net/cgi-bin/trac.cgi/roadmap Roadmap]
    6666and all tasks, that we have defined yet:
    6767 * [https://www.orxonox.net/cgi-bin/trac.cgi/report/1 Tasks]
    68 You will see the current changes on the orxonox source and the wiki on
    69 the timline of our wiki:
     68You will see the current changes on the orxonox source and the Wiki on
     69the timeline of our Wiki:
    7070* [https://www.orxonox.net/cgi-bin/trac.cgi/timeline timeline]
    7171The commit messages will also be sent to your email adress, if you have registered to the orxonox-commit mailinglist
    … …  
    7373
    7474== 10. Understanding Orxonox ==
    75 It definitly take some time to understand the Orxonox code. The best way to get your questions answered is to post them on the development-mailinglist. Even better is to just go to the developers and ask them to give you an overview... Once you know where to find which functions, you will want to read some more about special topics in the sourcefiles itself: we use doxygen to comment the code, so you will find a comment to every class/function. There is a second source of information, that we are currently working
     75It definitely takes some time to understand the Orxonox source code. The best way to get your questions answered is to post them on the development-mailinglist. Even better is to just go to the developers and ask them to give you an overview... Once you know where to find which functions, you will want to read some more about special topics in the source files themselves: we use doxygen to comment the code, so you will find comments for every class/function. There is a second source of information, which we are currently working
    7676on: [wiki:ModulesDescription module description]
    7777