Difference between revisions of "Getting Started for Platform Developers"

From Sirikata Wiki
Jump to navigation Jump to search
(Add link for explanation of git branches)
(Move the documentation page up front as the comprehensive map for platform development resources)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
<noinclude>
 
Platform developers work on the code which runs the core of Sirikata worlds. Both the core system and plugins implementing. Examples of code developed by platform developers are the core message forwarding code, physics simulation plugins, the renderer for clients, and scripting plugins.
 
Platform developers work on the code which runs the core of Sirikata worlds. Both the core system and plugins implementing. Examples of code developed by platform developers are the core message forwarding code, physics simulation plugins, the renderer for clients, and scripting plugins.
 +
</noinclude>
 +
=== Map for Platform Development ===
 +
* [[Documentation|Documentation]] is very much a work in progress but is a comprehensive overview of what we currently have. Covers just about all the technical aspects of the system, tools and infrastructure around it, and how to work with it. If you're looking for a particular topic, start here.
  
 
=== Getting into the Code ===
 
=== Getting into the Code ===
Line 6: Line 10:
 
** Learn about the available [[Git Branches|branches in the git repository]], how to work with them, and how to develop new features.
 
** Learn about the available [[Git Branches|branches in the git repository]], how to work with them, and how to develop new features.
 
** We're not too picky, but we suggest following the [[Coding Standards]] so we have a consistent, readable codebase.
 
** We're not too picky, but we suggest following the [[Coding Standards]] so we have a consistent, readable codebase.
−
* The [http://www.sirikata.com/docs/guides/platformguide/ Platform Developer's Guide] is the best reference for platform development.  It provides:
+
* The [[Guides/Platform_Development|Platform Development Guide]] explains how to work with the code.
−
** A high-level breakdown of the [http://www.sirikata.com/docs/guides/platformguide/components/ components of Sirikata's architecture], followed by more detail on each component.
 
−
** A [http://www.sirikata.com/docs/guides/platformguide/tour/ tour of the source code] should help you get into the code and figure out where you want to start working.
 
−
** [http://www.sirikata.com/docs/guides/platformguide/tutorials/ Tutorials] covering a few common tasks in the Sirikata code and describing how to use some utilities already available within the code base.
 
−
 
 
−
* [[Documentation|Documentation]] is very much a work in progress but this is an overview what we currently have
 
  
 
=== Getting in Touch with Other Developers ===
 
=== Getting in Touch with Other Developers ===

Latest revision as of 01:26, 26 May 2012

Platform developers work on the code which runs the core of Sirikata worlds. Both the core system and plugins implementing. Examples of code developed by platform developers are the core message forwarding code, physics simulation plugins, the renderer for clients, and scripting plugins.

Map for Platform Development

  • Documentation is very much a work in progress but is a comprehensive overview of what we currently have. Covers just about all the technical aspects of the system, tools and infrastructure around it, and how to work with it. If you're looking for a particular topic, start here.

Getting into the Code

Getting in Touch with Other Developers

  • Need to talk to other platform developers to bounce implementation ideas off them or ask questions about the code? Platform Developer Communication describes how to get in touch with other platform developers, both synchronously and asynchronously.

How and Where to Contribute

Retrieved from "http://www.sirikata.com/wiki/index.php?title=Getting_Started_for_Platform_Developers&oldid=1287"