We are currently working on creating more documentation. We distinguish three levels of information. The levels are somewhat ordered so for lower levels you should also read the documentation on the higher levels.
- Fawkes User
- Someone gave you a robot running Fawkes and you have to use it now. This is also the first step if you want to use Fawkes on your robot when you did not before. This also gives you a bird's eye view on the software.
- Plugin Developer
- You have a robot running Fawkes and now want to write new or extend existing plugins to suit your needs.
- Fawkes Developer
- You want to have a look under the hood know how Fawkes does things internally on the lowest levels or you want to join the Fawkes Robot Software Framework (RSF) team.
The documentation is maintained in the
Fawkes Trac. Look there for an overview of the documentation. Some articles of particular relevance:
- Fawkes Trac
- General documentation wiki, ticket tracking, source code browsing etc.
- DeveloperGettingStartedGuide
- How to get started developing with Fawkes.
- API Reference
- Class documentation for Fawkes.
We will provide more documentation during the next days and weeks. Consider the current 0.3 release as a preview release that you can experiment with. The next 0.4 release will provide a nicer user environment.