Difference between revisions of "Development Team/Resources"
(→Tutorials: Sugarizing) |
|||
| (37 intermediate revisions by 14 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | <noinclude>{{TeamHeader|Development Team|roadmap_link={{Upcoming Stable Release}}/Roadmap}}</noinclude> |
| − | |||
| − | |||
| − | + | {{Note/important|Please note|See this [http://developer.sugarlabs.org/ developer documentation website] for the '''sugar-build''' development environment.}} | |
| − | |||
| − | [[ | + | '''Are you looking for [[Activity_Team/Resources|documentation on how to create Sugar Activities]]?''' |
| − | + | {{:Development Team/Sugar_Architectural_Diagram}} | |
| − | |||
| − | + | Sugar is built on top of the GNU/Linux desktop: GTK, X11, D-Bus, Network Manager, Gconf, Telepthay, etc. We use the Matchbox window manager (but are in the process of switching to Metacity). Sugar provides a data-storage service and a presence service that are accessed through D-Bus, thus Sugar Activities can be coded in any language. The majority are written in Python, which takes advantage of binding in the Sugar-Toolkit. The Sugar shell manages the desktop and the Journal. | |
| − | + | == Tutorials == | |
| − | + | [[olpc:Developers/Stack#Python/PyGTK | PyGTK]] developers will find a collection of [[olpc:Tutorials |Tutorials]] available, from very simple Hello World projects to an in-depth description of the development of [[olpc:Block_Party|Block Party]]. | |
| − | * [[ | + | [[olpc:Developers/Stack#OLPCGames| Pygame]] developers will likely want to start with: |
| + | |||
| + | * [[olpc:Game_Development_Newbies| Game Development Newbies]] -- general introduction | ||
| + | * [[olpc:Game_development_HOWTO |Game development HOWTO]] -- 5-minutes to your first activity in [http://wiki.laptop.org/go/Pygame Pygame] | ||
| + | |||
| + | [[olpc:Developers/Stack#Etoys|Etoys]]/Smalltalk developers will want to start with [olpc:Smalltalk_Development_on_XO|Smalltalk Development on XO]]. | ||
| + | |||
| + | Other developers will want to read about [[olpc:Sugarizing|Sugarizing]] non-Python applications. | ||
| + | |||
| + | == Reference == | ||
| + | |||
| + | * http://api.sugarlabs.org/ -- pointers to the various libraries' reference documentation. | ||
| + | * [[Development Team/Low-level Activity API|Low-level Activity API]] -- how to write Sugar activities without Python | ||
| + | * [[Development Team/Release]] -- Sugar platform release process | ||
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: | 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: | ||
| Line 25: | Line 34: | ||
pydoc -p 8080 | pydoc -p 8080 | ||
| − | then open a [[ | + | then open a [[OLPC:Browse|Web Browser]] activity and go to the url: |
http://localhost:8080/ | http://localhost:8080/ | ||
| Line 31: | Line 40: | ||
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). | 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). | ||
| − | == | + | == Beginner's tools == |
| + | Link to Andrew's course in the Overview chapter of the Extending | ||
| + | Sugar section of the FLOSS manual for Sugar | ||
| + | (http://en.flossmanuals.net/Sugar/Overview). | ||
| − | + | # The Byte of Python (http://www.swaroopch.com/notes/Python) | |
| − | + | # How to Think Like a Computer Scientist: Learning with Python, 2nd edition (http://openbookproject.net/thinkcs/python2e.php) | |
| + | # Python for Fun (http://www.openbookproject.net/py4fun/) | ||
| + | # Python Bibliotheca (http://www.openbookproject.net/pybiblio/) | ||
| + | # Dive into Python (http://diveintopython.org/) | ||
| + | # Hands-on Python Tutorial (http://www.cs.luc.edu/~anh/python/hands-on/) | ||
| + | # Snake Wrangling for Kids (http://www.briggs.net.nz/log/writing/snake-wrangling-for-kids/) | ||
| + | # PyGame (scattered throughout the site) (http://www.pygame.org/) | ||
| + | |||
| + | Please feel free to add other suggested resources to the ones already there and to add some | ||
| + | feedback, e.g., good for beginners/experts, etc. | ||
== FAQ == | == FAQ == | ||
| − | The [[Developers/ | + | The [[OLPC:Developers/FAQ]] is large enough to merit its own page in the Developer's manual. |
| − | = Contributing = | + | == Contributing == |
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. | 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. | ||
| − | + | [[Category:Development Team]] | |
| − | + | [[Category:Resource]] | |
| − | [[ | ||
Latest revision as of 16:33, 22 July 2014
See this developer documentation website for the sugar-build development environment.
Are you looking for documentation on how to create Sugar Activities?
Regular X applications |
Non-Python Sugar Activities (Etoys, Simcity, Mono, etc.) |
Sugar shell (desktop window, panel, Journal) |
Python Sugar Activities
| ||||
Sugar toolkit (Python-only)
| |||||||
Datastore service |
Presence service
| ||||||
Matchbox window manager
(We are in the process of switching to Metacity) | |||||||
GNOME-ish Linux desktop
X11, HAL, D-Bus, NetworkManager, GConf, Telepathy, etc | |||||||
Sugar is built on top of the GNU/Linux desktop: GTK, X11, D-Bus, Network Manager, Gconf, Telepthay, etc. We use the Matchbox window manager (but are in the process of switching to Metacity). Sugar provides a data-storage service and a presence service that are accessed through D-Bus, thus Sugar Activities can be coded in any language. The majority are written in Python, which takes advantage of binding in the Sugar-Toolkit. The Sugar shell manages the desktop and the Journal.
Tutorials
PyGTK developers will find a 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
Etoys/Smalltalk developers will want to start with [olpc:Smalltalk_Development_on_XO|Smalltalk Development on XO]].
Other developers will want to read about Sugarizing non-Python applications.
Reference
- http://api.sugarlabs.org/ -- pointers to the various libraries' reference documentation.
- Low-level Activity API -- how to write Sugar activities without Python
- Development Team/Release -- Sugar platform release process
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).
Beginner's tools
Link to Andrew's course in the Overview chapter of the Extending Sugar section of the FLOSS manual for Sugar (http://en.flossmanuals.net/Sugar/Overview).
- The Byte of Python (http://www.swaroopch.com/notes/Python)
- How to Think Like a Computer Scientist: Learning with Python, 2nd edition (http://openbookproject.net/thinkcs/python2e.php)
- Python for Fun (http://www.openbookproject.net/py4fun/)
- Python Bibliotheca (http://www.openbookproject.net/pybiblio/)
- Dive into Python (http://diveintopython.org/)
- Hands-on Python Tutorial (http://www.cs.luc.edu/~anh/python/hands-on/)
- Snake Wrangling for Kids (http://www.briggs.net.nz/log/writing/snake-wrangling-for-kids/)
- PyGame (scattered throughout the site) (http://www.pygame.org/)
Please feel free to add other suggested resources to the ones already there and to add some feedback, e.g., good for beginners/experts, etc.
FAQ
The OLPC:Developers/FAQ is large enough to merit its own page in the Developer's manual.
Contributing
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.