Merge pull request #11320 from MrTucks/patch-2
[betaflight.git] / docs / Introduction.md
blobe6918455097d1b46fe67d305743179341ffc1f63
1 # Cleanflight
3 ![Cleanflight](assets/cleanflight/cleanflight-logo-light-wide-1-240px.jpg)
5 Welcome to CleanFlight!
7 Cleanflight is an community project which attempts to deliver flight controller firmware and related tools.
9 ## Primary Goals
11 * Community driven.
12 * Friendly project atmosphere.
13 * Focus on the needs of users.
14 * Great flight performance.
15 * Understandable and maintainable code.
17 ## Hardware
19 See the [flight controller hardware](Boards.md) chapter for details.
21 ## Software
23 There are two primary components, the firmware and the configuration tool.  The firmware is the code that runs on the flight controller board.  The GUI configuration tool (configurator) is used to configure the flight controller, it runs on Windows, OSX and Linux.
25 ## Feedback & Contributing
27 We welcome all feedback.  If you love it we want to hear from you, if you have problems please tell us how we could improve things so we can make it better for everyone.
29 If you want to contribute please see the notes here:
31 https://github.com/cleanflight/cleanflight#contributing
33 Developers should read this:
35 https://github.com/cleanflight/cleanflight/blob/master/CONTRIBUTING.md