rusefi
/
atbetaflight
mirror of https://github.com/rusefi/atbetaflight.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating the project readme.

This commit is contained in:
Dominic Clifton 2014-04-21 03:27:28 +01:00
parent 68b9b9062f
commit 06b3e46b8b
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,6 +1,25 @@
baseflight
==========
Cleanflight
===========
Clean-code version of baseflight flight-controller - flight controllers are used to fly multi-rotor craft and fixed wing craft.
This fork differs from baseflight in that it attempts to use modern software development practices which result in:
1) greater reliability through code robustness.
2) easier maintainance through code cleanliness.
3) easier to develop new features.
4) easier to re-use code though code de-coupling and modularisation.
32 bit fork of the MultiWii RC flight controller firmware
Before making any contributions, take a note of the https://github.com/multiwii/baseflight/wiki/CodingStyle
For this fork it is also advised to read about clean code, here are some useful links:
http://cleancoders.com/
http://en.wikipedia.org/wiki/SOLID_%28object-oriented_design%29
http://en.wikipedia.org/wiki/Code_smell
http://en.wikipedia.org/wiki/Code_refactoring
http://www.amazon.co.uk/Working-Effectively-Legacy-Robert-Martin/dp/0131177052
The MultiWii software, from which baseflight originated, violates many good software development best-practices. Hopefully this fork will go some way to address them.
If you see any bad code in this fork please immediate raise an issue so it can be fixed, or better yet submit a pull request.