Mirror/betaflight
1
0
Fork 0
mirror of https://github.com/betaflight/betaflight.git synced 2025-07-26 01:35:41 +03:00
Code Issues Wiki Activity

Align the markdown format with the firmware documentation. Minor

Browse source 
documentation updates.
This commit is contained in:
Dominic Clifton 2015-01-26 19:39:20 +01:00
parent 9f51326ebf
commit ebbf3de5e1
1 changed files with 41 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

71
README.md
View file

@ -1,5 +1,4 @@
Cleanflight Configurator # Cleanflight Configurator
========================
Cleanflight Configurator is a crossplatform configuration tool for the [Cleanflight](http://cleanflight.com/) flight control system. Cleanflight Configurator is a crossplatform configuration tool for the [Cleanflight](http://cleanflight.com/) flight control system.
@ -9,8 +8,8 @@ Various types of aircraft are supported by the tool and by cleanflight, e.g. qua
[![available in the Chrome web store](https://developer.chrome.com/webstore/images/ChromeWebStore_Badge_v2_206x58.png)](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb) [![available in the Chrome web store](https://developer.chrome.com/webstore/images/ChromeWebStore_Badge_v2_206x58.png)](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
Authors ## Authors
-------
Dominic Clifton/hydra - maintainer of the Cleanflight firmware and configurator. Dominic Clifton/hydra - maintainer of the Cleanflight firmware and configurator.
Cleanflight Configurator was originally a [fork](#credits) of Baseflight Configurator with support for Cleanflight instead of Baseflight. Cleanflight Configurator was originally a [fork](#credits) of Baseflight Configurator with support for Cleanflight instead of Baseflight.
@ -18,53 +17,65 @@ Cleanflight Configurator was originally a [fork](#credits) of Baseflight Configu
This configurator is the only configurator with support for Cleanflight specific features. It will likely require that you run the latest firmware on the flight controller. This configurator is the only configurator with support for Cleanflight specific features. It will likely require that you run the latest firmware on the flight controller.
If you are experiencing any problems please make sure you are running the [latest firmware version](https://github.com/cleanflight/cleanflight/releases/latest). If you are experiencing any problems please make sure you are running the [latest firmware version](https://github.com/cleanflight/cleanflight/releases/latest).
Installation ## Installation
------------
1. - Visit [Chrome web store](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
2. - Click **+ Free**
#### Alternative way ### Via chrome webstore
1. - Clone the repo to any local directory or download it as zip
2. - Start Chromium or Google Chrome and go to tools -> extension 1. Visit [Chrome web store](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
3. - Check the "Developer mode" checkbox 2. Click **+ Free**
4. - Click on load unpacked extension and point it to the Cleanflight Configurator directory (for example D:/cleanflight-configurator)
Please note - the application will automatically update itself when new versions are released. Please ensure you maintain configuration backups as described in the Cleanflight documentation.
### Alternative way
1. Clone the repo to any local directory or download it as zip
2. Start Chromium or Google Chrome and go to tools -> extension
3. Check the "Developer mode" checkbox
4. Click on load unpacked extension and point it to the Cleanflight Configurator directory (for example D:/cleanflight-configurator)
## How to use
How to use
-----------
You can find the Cleanflight Configurator icon in your application tab "Apps" You can find the Cleanflight Configurator icon in your application tab "Apps"
WebGL ## Notes
-----
### WebGL
Make sure Settings -> System -> "User hardware acceleration when available" is checked to achieve the best performance Make sure Settings -> System -> "User hardware acceleration when available" is checked to achieve the best performance
Linux users ### Linux users
-----------
1. Dont forget to add your user into dialout group "sudo usermod -aG dialout YOUR_USERNAME" for serial access 1. Dont forget to add your user into dialout group "sudo usermod -aG dialout YOUR_USERNAME" for serial access
2. If you have 3D model animation problems, enable "Override software rendering list" in Chrome flags chrome://flags/#ignore-gpu-blacklist 2. If you have 3D model animation problems, enable "Override software rendering list" in Chrome flags chrome://flags/#ignore-gpu-blacklist
Support ## Support
-------
For non-Cleanflight specific issues please raise them here so that the get fixed in the primary codebase:
https://github.com/multiwii/baseflight-configurator/issues If you need help your please use the multiwii or rcgroups forums or visit the IRC channel before raising issues in the issue trackers.
For Cleanflight specific issues raise them here: ### Issue trackers
For Cleanflight configurator issues raise them here
https://github.com/cleanflight/cleanflight-configurator/issues https://github.com/cleanflight/cleanflight-configurator/issues
For Cleanflight firmware issues raise them here
https://github.com/cleanflight/cleanflight/issues
### IRC Channel
There is an IRC channel for Cleanflight, here: irc://irc.freenode.net/#cleanflight There is an IRC channel for Cleanflight, here: irc://irc.freenode.net/#cleanflight
Support for Baseflight Configurator can also be found on IRC, here: irc://irc.freenode.net/#multiwii Support for Baseflight Configurator can also be found on IRC, here: irc://irc.freenode.net/#multiwii
Technical details ## Technical details
-----------------
The configurator is based on chrome.serial API running on Google Chrome/Chromium core. The configurator is based on chrome.serial API running on Google Chrome/Chromium core.
Developers ## Developers
----------
We accept clean and reasonable patches, submit them! We accept clean and reasonable patches, submit them!
Credits ## Credits
-------
ctn - primary author and maintainer of Baseflight Configurator from which this project was forked. ctn - primary author and maintainer of Baseflight Configurator from which this project was forked.