README.md

   1 # Cleanflight
   2
   3 ![Cleanflight](docs/assets/cleanflight/cleanflight-logo-light-wide-1-240px.jpg)
   4
   5 Cleanflight is flight controller software for multi-rotor and fixed wings.  The cleanflight project, and related projects such as betaflight and iNav are
   6 used on the majority of flight controllers used around the world.  There is no other software used on as many flight-controllers!
   7
   8 * If you're looking for cutting edge performance and don't mind doing your homework, checkout the [betaflight fork](https://github.com/betaflight/betaflight).
   9 * If you're looking for advanced navigation features then check out the [iNav fork](https://github.com/iNavFlight/inav).
  10 * All other users should use cleanflight.
  11
  12 Features:
  13
  14 * Support for modern STM32 based processors F1/F3/F4/F7.
  15 * Support for modern accelerometer/gyro/barometer/compass sensors.
  16 * Support for modern ESC technologies DSHOT/ONESHOT and legacy PWM.
  17 * Support for Multi-color RGB LED strip support.
  18 * Advanced on-board telemetry logging (Blackbox).
  19 * Wide support of receivers (SBus/iBus/SumD/SumH/PPM/PWM)
  20 * Wide support of telemetry protocols (FrSky/SmartPort/S.Port/HoTT/iBus/LTM).
  21 * Built-in OSD support & configuration without needing third-party OSD software/firmware/comm devices.
  22 * VTX support (RTC6705/Unify Pro/IRC Tramp/etc).
  23 * and MUCH, MUCH more.
  24
  25 ## Installation & Documentation
  26
  27 See: https://github.com/betaflight/betaflight/wiki
  28
  29 ## Support
  30
  31 * Github issue track is NOT for end-user support.
  32
  33 ## IRC Support and Developers Channel
  34
  35 There's a dedicated Cleanflight IRC channel on the Freenode IRC network. Many users and some of the developers frequent there, and it is a helpful and friendly community - but there are two important things to keep in mind: First and most importantly, please go ahead and ask if you have questions, but **make sure you wait around long enough for a reply**. Next, sometimes people are out flying, asleep or at work and can't answer immediately, even though they are present in the channel. This is how IRC works: Many people stay logged in, even though they are not actively participating in the discussion all the time. Have a seat, grab a drink and hang around if it's a quiet time of day.
  36
  37 irc://irc.freenode.net/#cleanflight
  38
  39 If you are using Windows and don't have an IRC client installed, take a look at [HydraIRC](http://hydrairc.com/).
  40
  41 There's a dedicated Slack chat channel for betaflight here:
  42
  43 http://www.betaflight.tk/
  44
  45 Etiquette: Don't ask to ask and please wait around long enough for a reply - sometimes people are out flying, asleep or at work and can't answer immediately.
  46
  47 ## Videos
  48
  49 There is a dedicated Cleanflight YouTube channel which has progress update videos, flight demonstrations, instructions and other related videos.
  50
  51 https://www.youtube.com/playlist?list=PL6H1fAj_XUNVBEcp8vbMH2DrllZAGWkt8
  52
  53 Please subscribe and '+1' the videos if you find them useful.
  54
  55 ## Configuration Tool
  56
  57 To configure Cleanflight you should use the [Cleanflight-configurator GUI tool](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb
  58 ) (Windows/OSX/Linux).
  59
  60 The source for it is here:
  61
  62 https://github.com/cleanflight/cleanflight-configurator
  63
  64 ## Contributing
  65
  66 Contributions are welcome and encouraged.  You can contribute in many ways:
  67
  68 * Documentation updates and corrections.
  69 * How-To guides - received help? Help others!
  70 * Bug reporting & fixes.
  71 * New feature ideas & suggestions.
  72
  73 See [CONTRIBUTING.md](CONTRIBUTING.md)
  74
  75 ## Developers
  76
  77 Please refer to the development section in the [docs/development](https://github.com/cleanflight/cleanflight/tree/master/docs/development) folder.
  78
  79 TravisCI is used to run automatic builds: https://travis-ci.org/cleanflight/cleanflight
  80
  81 https://travis-ci.org/cleanflight/cleanflight
  82
  83 [![Build Status](https://travis-ci.org/cleanflight/cleanflight.svg?branch=master)](https://travis-ci.org/cleanflight/cleanflight)
  84
  85 ## Cleanflight Releases
  86 https://github.com/cleanflight/cleanflight/releases
  87
  88 ## Open Source
  89
  90 Cleanflight is software that is **open source** and is available free of charge without warranty to all users.
  91
  92 The license is GPL3.
  93
  94 ## Project/Fork History
  95
  96 Cleanflight is forked from Baseflight, which is now dead, all primary development happens in Cleanflight, betaflight and iNav forks.
  97
  98 Cleanflight v2.x -> betaflight -> cleanflight v1.x -> baseflight -> multiwii
  99
 100 ## Contributors
 101
 102 Thanks goes to all those whom have contributed to Cleanflight and its origins.
 103
 104 Primary developers:
 105 * Dominic Clifton (hydra) - *cleanflight founder*
 106 * Boris B (borisbstyle) - *betaflight founder*
 107 * digitalentity - *inav founder*
 108 * Martin Budden (martinbudden)
 109 * Jason Blackman (blckmn)
 110
 111 Big thanks to current and past contributors:
 112 * **Alexinparis** (for MultiWii),
 113 * **timecop** (for Baseflight),
 114 * **Sambas** (for the original STM32F4 port).
 115 * Bardwell, Joshua (joshuabardwell)
 116 * ctzsnooze
 117 * Höglund, Anders (andershoglund)
 118 * Ledvin, Peter (ledvinap) - **IO code awesomeness!**
 119 * kc10kevin
 120 * Keeble, Gary (MadmanK)
 121 * Keller, Michael (mikeller) - **Configurator brilliance**
 122 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 123 * MJ666
 124 * Nathan (nathantsoi)
 125 * ravnav
 126 * sambas - **bringing us the F4**
 127 * savaga
 128 * Stålheim, Anton (KiteAnton)
 129 * prodrone - **failsafe work**
 130 * **ctn** - **for the original Configurator**
 131
 132 And many many others who haven't been mentioned....
 133