Skip to content

Commit

Permalink
Update readme formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
hydra committed Apr 21, 2014
1 parent 9b8a10a commit 51f2487
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,22 @@ Clean-code version of baseflight flight-controller - flight controllers are used

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.
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.

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.

Contributing
============

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.
* 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

0 comments on commit 51f2487

Please sign in to comment.