README.md 1.54 KB
Newer Older
Dominic Clifton's avatar
Dominic Clifton committed
1
2
3
4
5
6
7
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:

Dominic Clifton's avatar
Dominic Clifton committed
8
9
10
11
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.
dongie's avatar
dongie committed
12

Dominic Clifton's avatar
Dominic Clifton committed
13
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 immediately raise an issue so it can be fixed, or better yet submit a pull request.
Dominic Clifton's avatar
Dominic Clifton committed
14

15
16
17
18
19
20
21
22
Documentation
=============

There is some documentation here: https://github.com/hydra/cleanflight/tree/master/docs 
If what you need is not covered then refer to the baseflight documentation.
If you still can't find what you need then stop by #multiwii on the Freenode IRC network - irc://irc.freenode.net/#multiwii


Dominic Clifton's avatar
Dominic Clifton committed
23
24
Contributing
============
dongie's avatar
dongie committed
25
26

Before making any contributions, take a note of the https://github.com/multiwii/baseflight/wiki/CodingStyle
Dominic Clifton's avatar
Dominic Clifton committed
27
28
29

For this fork it is also advised to read about clean code, here are some useful links:

Dominic Clifton's avatar
Dominic Clifton committed
30
31
32
33
34
* 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