Difference between revisions of "Documentation"

From Sirikata Wiki
Jump to: navigation, search
m (Reverted edits by Skldgj (talk) to last revision by Jterrace)
Line 1: Line 1:
Please consider this page an early work in progress and feel free to contribute or make suggestion on the [http://groups.google.com/group/platformtalk developer list].
+
== Guides ==
 +
The primary source for documentation should be [http://www.sirikata.com/docs/head/guides/ the official guides] (application developer guide, world developer guide, and platform developer guide). If you want to contribute back to these, check out [http://github.com/sirikata/sirikata-docs the documentation repository].
  
 
== Learning the System ==
 
== Learning the System ==
Line 10: Line 11:
 
* [[Subsystems|Subsystems]] describes how the [[System Architecture|Architecture]] is broken down to smaller components and how they map to our source code repository.
 
* [[Subsystems|Subsystems]] describes how the [[System Architecture|Architecture]] is broken down to smaller components and how they map to our source code repository.
 
* [[Coding Standards]] is a description of how to keep our source code consistent and readable.
 
* [[Coding Standards]] is a description of how to keep our source code consistent and readable.
* [http://www.sirikata.com/docs/head/ Doxygen Documentation] generated nightly from the Git repository gives low level documentation about the components that make up Sirikata.
+
* [http://www.sirikata.com/docs/head/api/ Doxygen Documentation] generated nightly from the Git repository gives low level documentation about the components that make up Sirikata.
 
* [[Dependencies|Dependencies]] are libraries Sirikata builds on. The libraries and their uses are described, followed by suggestions on how to get the necessary dependencies running on a new platform when porting Sirikata.
 
* [[Dependencies|Dependencies]] are libraries Sirikata builds on. The libraries and their uses are described, followed by suggestions on how to get the necessary dependencies running on a new platform when porting Sirikata.
 
* [[CDN Transfer Layer]] describes the new interface for accessing files from the CDN
 
* [[CDN Transfer Layer]] describes the new interface for accessing files from the CDN

Revision as of 02:14, 3 February 2011

Guides

The primary source for documentation should be the official guides (application developer guide, world developer guide, and platform developer guide). If you want to contribute back to these, check out the documentation repository.

Learning the System

  • Architecture gives a high level overview of Sirikata's architecture. Only the highest level components are described, making this the best place to start.
  • Protocol describes our current wire protocol. This is subject to change.
  • Type Systems describes the types we want our serialization format to natively support to minimize the amount of tedious work platform developers and end-user scripters need to do to exchange data.

Source Code

  • Source Code describes the infrastructure related to our source code. This describes both how to get and build the code, as well as how developers can work with our infrastructure to add new source code.
  • Subsystems describes how the Architecture is broken down to smaller components and how they map to our source code repository.
  • Coding Standards is a description of how to keep our source code consistent and readable.
  • Doxygen Documentation generated nightly from the Git repository gives low level documentation about the components that make up Sirikata.
  • Dependencies are libraries Sirikata builds on. The libraries and their uses are described, followed by suggestions on how to get the necessary dependencies running on a new platform when porting Sirikata.
  • CDN Transfer Layer describes the new interface for accessing files from the CDN

Getting Involved

  • Coding Projects describes some ideas for projects a new developer might be interested in working on and that core developers believe would be feasible within the current system. These are just ideas and new developers should not, of course, limit themselves to these options.

Plugins

Working with Sirikata

  • Video Capture describes current best practices for collecting video captures from Sirikata.

Other

  • Developer Preview is our system prototype from December 2008. This system is now completely out of date and likely only useful for reference and historical purposes.