Fawkes Trac
Welcome to the Fawkes Trac. It is the central place for information and documentation for Fawkes users and developers.
Fawkes Developers
- FawkesBuildSystem
- How the Fawkes build system works and how to tweak it.
Fawkes Users
- GettingStartedGuide
- Start here to get a general overview about how to start Fawkes and execute basic tasks when Fawkes is already installed on the robot.
- FawkesSetup?
- How to start using Fawkes initially on your machine or a new robot.
- PluginList?
- List of plugins with descriptions how to congigure and use them.
- GuiTools?
- List of GUI utilities and how to use them.
- ConsoleTools?
- List of console tools and how to use them.
- FawkesDependencies
- Other software libraries and tools you need to run Fawkes (and to develop using Fawkes).
Plugin Developers
- DeveloperGettingStartedGuide
- How to get started developing with Fawkes.
- CodingStyle
- The recommended plugin layout and coding styles that are used in Fawkes.
- GitNotes?
- Notes on using the git version control system.
- PluginHowto?
- Step by step instructions how to write a new plugin from scratch.
- PluginDebuggingTips?
- Tips how to debug a plugin.
- PluginPadawanPitfalls?
- Typical problems new plugin developers run into.
We distinguish three different levels of information in this wiki. 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.
