Tux Droid Suite development wiki
From Tuxisalive
English • Français
ks156 18:19, 23 April 2009 (UTC) : This article should be rewritten in a clearer way
Tux Droid Suite Development Project is an Open Source project dedicated to create smart-companion features, primarily but not only for Tux Droid robot. Current wiki page is the main entry of the developer community portal.
Contents |
Project
Tux Droid Suite development project is an Open Source project dedicated to create smart-companion features. The issues discussed here are relative to the "Tux Droid Suite", the name given to the current combination of software V3 and Tux Droid firmware.
Development contributions can be about various topics:
- APIs in various programming languages: C++, python, ...
- Firmware of Tux Droid
- Plugins development
- Package building for Linux
- Bug tracking
Contributions other than development can be made in others topics such as
- Translating plugins: internationalization is based on I18N standard and PO files.
- Writing or translating tutorials and wiki articles
- Discussing about software architecture, potential applications
How to get involved
You can find a list of tasks we've planned to do here : How to get involved.
You also will get in touch with the developer community through the following tools
Mailing Lists
- subscribing to the mailing list at Mailing Lists.
- browsing and searching for Tux Droid User mailing list at archives-sourceforge-user or from gmane archives-gmane-user
- browsing and searching for Tux Droid Developer mailing list at archives-sourceforge-svn or from gmane archives-gmane-svn
Forums
- writing your comments and questions on the forums at Developers-Forums. Your remarks and new ideas are welcomed.
IRC
- talking with the Tux Droid community live on our irc room at IRC
- Channel : #tuxdroid / server : irc.freenode.net
- There is currently
users connected in the IRC Channel. Join us !
Development
SVN
A public SVN repository has been setup at SVN. Comments about svn organization can be found here : svn structure
- Email notifications can be obtained by subscribing at our automated check-ins list tux-droid-svn.
- Browsing and searching archives tux-droid-svn archives can be done using tux-droid-svn-browse. Gmane tool allows the same features at (gmane-browse) and search (gmane-search).
- Statistics and RSS feeds can be found at CIA statistics
- Patches using unified diff format (diff -u) can be submitted. They will be evaluated and added to SVN.
Trackers
Three trackers have been set up to report bugs.
- The main one is at Main tracker.
It's a good idea to give some contact infos in the Who's who page so other developers can reach you if needed. It is important that you familiarize yourself with subversion before committing to the repository, to reduce the risk of accidental screw-ups. The Subversion book is a comprehensive, but surprisingly accessible resource.
Guidelines
We strongly recommend to read this article : General Guidelines before writing code.
While these guidelines are compatible with language specific styles, please prefers the option formulated in svn style document. Language specific style can be found at
- Indian Hill C style or C and C++ style for C
- Python Style for Python
- Java Style for Java
It is recommended to use Doxygen style comments for automated doc generation. However, use of language specific documentation generator is accepted (JavaDoc, Pydoc)
Code Documentation
Automated documentation
As far as possible, automated documentation is generated nightly at automated documentation.
Language specific documentation
Latest language specific documentation can be generated manually from svn repository. A basic version of code documentation can be found at Code documentation
How to ....
A list of software suite usages for developers.
- Installation
- Applications use
- Experiment Tux Droid Server
- Experiment APIs
- Experiment Tux Droid and Google Gadgets
- Experiment Tux Droid Plugins in various programming languages
- Updating firmware
General
Downloads
You may download stable code builds and TTS packages at download. When available installers like
are provided on the download site.
Specific Topics
- new RF explains the changes made on firmware 0.9 and the new RF firmware.
- NAS will detail how to use Tux Droid with a Network Access Server (NAS) like the linksys NSLU2 or Asus WL-500gP.
- Speech recognition integration with Tux Droid.
- Text-to-speech with Acapela and other alternatives.
- AI artificial intelligence.
- LIRC driver to get Tux's remote control compatible with LIRC.
- Portal : A Tuxdroid community webinterface Project
Glossary
Main terms referred in documentation can be found at Glossary
FAQ
Freaks Asking Questions, not to be mistaken with the Frequently Asked Questions ;-)
Who's who
Contacts with active developers can be found at Who's_who
