Developers/Documentation: Difference between revisions
Jump to navigation
Jump to search
(Splitting out the documentation resources) |
(Describe the snippets page) |
||
| Line 1: | Line 1: | ||
[[Developers/Communication|Previous |
[[Developers/Communication|Previous]] [[Developers/FAQ|Next]] |
||
As with most software projects, we have difficulties with documentation. We are '''very''' interested in finding people interested in documenting the system. If you are |
As with most Open Source software projects, we have difficulties with documentation. We are '''very''' interested in finding people interested in documenting the system. If you are too shy about your coding skills to write code, helping us document the code-base would be an amazing and valuable contribution. |
||
= Tutorials = |
|||
[[Developers/Stack#Python/PyGTK|PyGTK]] developers will find a whole collection of [[Tutorials]] available, from very simple Hello World projects to an in-depth description of the development of [[Block Party]]. |
|||
See the [[Tutorials]] page for introductory and quick-start tutorials. Game developers will likely want to focus on: |
|||
[[Developers/Stack#OLPCGames|Pygame]] developers will likely want to start with: |
|||
* [[Game Development Newbies]] -- general introduction |
* [[Game Development Newbies]] -- general introduction |
||
* [[Game development HOWTO]] -- 5-minutes to your first activity in [[Pygame]] |
* [[Game development HOWTO]] -- 5-minutes to your first activity in [[Pygame]] |
||
= Reference = |
|||
See the [[API Reference]] for pointers to the various libraries' reference documentation. You can also run the pydoc script on an XO in order to have browseable pydoc documentation locally. To do this, open a Terminal activity and run: |
|||
pydoc -p 8080 |
|||
then open a [[Web|Web Browser]] activity and go to the url: |
|||
http://localhost:8080/ |
|||
to view the documentation. This approach works best with Python-coded libraries which have spent some time on their docstrings (and generally requires that you know English, as most docstrings are written in English). |
|||
See the [[API Reference]] for pointers to the various libraries' reference documentation. |
|||
== Resources == |
|||
* The [[:Category:Developers | Developer's Category]] collects everything in the wiki that's been tagged as pertaining to developers (it's a bit hard to navigate) |
* The [[:Category:Developers | Developer's Category]] collects everything in the wiki that's been tagged as pertaining to developers (it's a bit hard to navigate) |
||
* [[Developers Program]] focuses on development for the core system, but with information useful for activity developers as well |
* [[Developers Program]] focuses on development for the core system, but with information useful for activity developers as well |
||
* [[Sugar Code Snippets]] |
* [[Sugar Code Snippets]] a few canonical code fragments that may be of use when coding in PyGTK |
||
Code worth reading: |
|||
*[http://dev.laptop.org/git.do?p=projects/block-party-activity;a=tree BlockParty] for overall organization of an activity. |
|||
*[http://dev.laptop.org/git?p=projects/hellomesh;a=summary HelloMesh], [http://dev.laptop.org/git.do?p=projects/connect-activity;a=tree Connect] or [http://dev.laptop.org/git.do?p=projects/write;a=tree Write] for tubes. |
|||
[[Developers/Communication|Previous |
[[Developers/Communication|Previous]] [[Developers/FAQ|Next]] |
||
Revision as of 01:20, 15 December 2007
As with most Open Source software projects, we have difficulties with documentation. We are very interested in finding people interested in documenting the system. If you are too shy about your coding skills to write code, helping us document the code-base would be an amazing and valuable contribution.
Tutorials
PyGTK developers will find a whole collection of Tutorials available, from very simple Hello World projects to an in-depth description of the development of Block Party.
Pygame developers will likely want to start with:
- Game Development Newbies -- general introduction
- Game development HOWTO -- 5-minutes to your first activity in Pygame
Reference
See the API Reference for pointers to the various libraries' reference documentation. You can also run the pydoc script on an XO in order to have browseable pydoc documentation locally. To do this, open a Terminal activity and run:
pydoc -p 8080
then open a Web Browser activity and go to the url:
http://localhost:8080/
to view the documentation. This approach works best with Python-coded libraries which have spent some time on their docstrings (and generally requires that you know English, as most docstrings are written in English).
Resources
- The Developer's Category collects everything in the wiki that's been tagged as pertaining to developers (it's a bit hard to navigate)
- Developers Program focuses on development for the core system, but with information useful for activity developers as well
- Sugar Code Snippets a few canonical code fragments that may be of use when coding in PyGTK