Copter: version to 4.5.0
[ardupilot.git] / README.md
blob7b603fc1632425f3db9f22d1a51b73b70f6c772a
1 # ArduPilot Project
3 <a href="https://ardupilot.org/discord"><img src="https://img.shields.io/discord/674039678562861068.svg" alt="Discord">
5 [![Test Copter](https://github.com/ArduPilot/ardupilot/workflows/test%20copter/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_sitl_copter.yml) [![Test Plane](https://github.com/ArduPilot/ardupilot/workflows/test%20plane/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_sitl_plane.yml) [![Test Rover](https://github.com/ArduPilot/ardupilot/workflows/test%20rover/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_sitl_rover.yml) [![Test Sub](https://github.com/ArduPilot/ardupilot/workflows/test%20sub/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_sitl_sub.yml) [![Test Tracker](https://github.com/ArduPilot/ardupilot/workflows/test%20tracker/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_sitl_tracker.yml)
7 [![Test AP_Periph](https://github.com/ArduPilot/ardupilot/workflows/test%20ap_periph/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_sitl_periph.yml) [![Test Chibios](https://github.com/ArduPilot/ardupilot/workflows/test%20chibios/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_chibios.yml) [![Test Linux SBC](https://github.com/ArduPilot/ardupilot/workflows/test%20Linux%20SBC/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_linux_sbc.yml) [![Test Replay](https://github.com/ArduPilot/ardupilot/workflows/test%20replay/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_replay.yml)
9 [![Test Unit Tests](https://github.com/ArduPilot/ardupilot/workflows/test%20unit%20tests/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_unit_tests.yml) [![test size](https://github.com/ArduPilot/ardupilot/actions/workflows/test_size.yml/badge.svg)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_size.yml)
11 [![Test Environment Setup](https://github.com/ArduPilot/ardupilot/actions/workflows/test_environment.yml/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_environment.yml)
13 [![Cygwin Build](https://github.com/ArduPilot/ardupilot/actions/workflows/cygwin_build.yml/badge.svg)](https://github.com/ArduPilot/ardupilot/actions/workflows/cygwin_build.yml) [![Macos Build](https://github.com/ArduPilot/ardupilot/actions/workflows/macos_build.yml/badge.svg)](https://github.com/ArduPilot/ardupilot/actions/workflows/macos_build.yml)
15 [![Coverity Scan Build Status](https://scan.coverity.com/projects/5331/badge.svg)](https://scan.coverity.com/projects/ardupilot-ardupilot)
17 [![Test Coverage](https://github.com/ArduPilot/ardupilot/actions/workflows/test_coverage.yml/badge.svg?branch=master)](https://github.com/ArduPilot/ardupilot/actions/workflows/test_coverage.yml)
19 [![Autotest Status](https://autotest.ardupilot.org/autotest-badge.svg)](https://autotest.ardupilot.org/)
21 ArduPilot is the most advanced, full-featured, and reliable open source autopilot software available.
22 It has been under development since 2010 by a diverse team of professional engineers, computer scientists, and community contributors.
23 Our autopilot software is capable of controlling almost any vehicle system imaginable, from conventional airplanes, quad planes, multi-rotors, and helicopters to rovers, boats, balance bots, and even submarines.
24 It is continually being expanded to provide support for new emerging vehicle types.
26 ## The ArduPilot project is made up of: ##
28 - ArduCopter: [code](https://github.com/ArduPilot/ardupilot/tree/master/ArduCopter), [wiki](https://ardupilot.org/copter/index.html)
30 - ArduPlane: [code](https://github.com/ArduPilot/ardupilot/tree/master/ArduPlane), [wiki](https://ardupilot.org/plane/index.html)
32 - Rover: [code](https://github.com/ArduPilot/ardupilot/tree/master/Rover), [wiki](https://ardupilot.org/rover/index.html)
34 - ArduSub : [code](https://github.com/ArduPilot/ardupilot/tree/master/ArduSub), [wiki](http://ardusub.com/)
36 - Antenna Tracker : [code](https://github.com/ArduPilot/ardupilot/tree/master/AntennaTracker), [wiki](https://ardupilot.org/antennatracker/index.html)
38 ## User Support & Discussion Forums ##
40 - Support Forum: <https://discuss.ardupilot.org/>
42 - Community Site: <https://ardupilot.org>
44 ## Developer Information ##
46 - Github repository: <https://github.com/ArduPilot/ardupilot>
48 - Main developer wiki: <https://ardupilot.org/dev/>
50 - Developer discussion: <https://discuss.ardupilot.org>
52 - Developer chat: <https://discord.com/channels/ardupilot>
54 ## Top Contributors ##
56 - [Flight code contributors](https://github.com/ArduPilot/ardupilot/graphs/contributors)
57 - [Wiki contributors](https://github.com/ArduPilot/ardupilot_wiki/graphs/contributors)
58 - [Most active support forum users](https://discuss.ardupilot.org/u?order=post_count&period=quarterly)
59 - [Partners who contribute financially](https://ardupilot.org/about/Partners)
61 ## How To Get Involved ##
63 - The ArduPilot project is open source and we encourage participation and code contributions: [guidelines for contributors to the ardupilot codebase](https://ardupilot.org/dev/docs/contributing.html)
65 - We have an active group of Beta Testers to help us improve our code: [release procedures](https://ardupilot.org/dev/docs/release-procedures.html)
67 - Desired Enhancements and Bugs can be posted to the [issues list](https://github.com/ArduPilot/ardupilot/issues).
69 - Help other users with log analysis in the [support forums](https://discuss.ardupilot.org/)
71 - Improve the wiki and chat with other [wiki editors on Discord #documentation](https://discord.com/channels/ardupilot)
73 - Contact the developers on one of the [communication channels](https://ardupilot.org/copter/docs/common-contact-us.html)
75 ## License ##
77 The ArduPilot project is licensed under the GNU General Public
78 License, version 3.
80 - [Overview of license](https://ardupilot.org/dev/docs/license-gplv3.html)
82 - [Full Text](https://github.com/ArduPilot/ardupilot/blob/master/COPYING.txt)
84 ## Maintainers ##
86 ArduPilot is comprised of several parts, vehicles and boards. The list below
87 contains the people that regularly contribute to the project and are responsible
88 for reviewing patches on their specific area.
90 - [Andrew Tridgell](https://github.com/tridge):
91   - ***Vehicle***: Plane, AntennaTracker
92   - ***Board***: Pixhawk, Pixhawk2, PixRacer
93 - [Francisco Ferreira](https://github.com/oxinarf):
94   - ***Bug Master***
95 - [Grant Morphett](https://github.com/gmorph):
96   - ***Vehicle***: Rover
97 - [Willian Galvani](https://github.com/williangalvani):
98   - ***Vehicle***: Sub
99 - [Lucas De Marchi](https://github.com/lucasdemarchi):
100   - ***Subsystem***: Linux
101 - [Michael du Breuil](https://github.com/WickedShell):
102   - ***Subsystem***: Batteries
103   - ***Subsystem***: GPS
104   - ***Subsystem***: Scripting
105 - [Peter Barker](https://github.com/peterbarker):
106   - ***Subsystem***: DataFlash, Tools
107 - [Randy Mackay](https://github.com/rmackay9):
108   - ***Vehicle***: Copter, Rover, AntennaTracker
109 - [Siddharth Purohit](https://github.com/bugobliterator):
110   - ***Subsystem***: CAN, Compass
111   - ***Board***: Cube*
112 - [Tom Pittenger](https://github.com/magicrub):
113   - ***Vehicle***: Plane
114 - [Bill Geyer](https://github.com/bnsgeyer):
115   - ***Vehicle***: TradHeli
116 - [Emile Castelnuovo](https://github.com/emilecastelnuovo):
117   - ***Board***: VRBrain
118 - [Georgii Staroselskii](https://github.com/staroselskii):
119   - ***Board***: NavIO
120 - [Gustavo José de Sousa](https://github.com/guludo):
121   - ***Subsystem***: Build system
122 - [Julien Beraud](https://github.com/jberaud):
123   - ***Board***: Bebop & Bebop 2
124 - [Leonard Hall](https://github.com/lthall):
125   - ***Subsystem***: Copter attitude control and navigation
126 - [Matt Lawrence](https://github.com/Pedals2Paddles):
127   - ***Vehicle***: 3DR Solo & Solo based vehicles
128 - [Matthias Badaire](https://github.com/badzz):
129   - ***Subsystem***: FRSky
130 - [Mirko Denecke](https://github.com/mirkix):
131   - ***Board***: BBBmini, BeagleBone Blue, PocketPilot
132 - [Paul Riseborough](https://github.com/priseborough):
133   - ***Subsystem***: AP_NavEKF2
134   - ***Subsystem***: AP_NavEKF3
135 - [Víctor Mayoral Vilches](https://github.com/vmayoral):
136   - ***Board***: PXF, Erle-Brain 2, PXFmini
137 - [Amilcar Lucas](https://github.com/amilcarlucas):
138   - ***Subsystem***: Marvelmind
139 - [Samuel Tabor](https://github.com/samuelctabor):
140   - ***Subsystem***: Soaring/Gliding
141 - [Henry Wurzburg](https://github.com/Hwurzburg):
142   - ***Subsystem***: OSD
143   - ***Site***: Wiki
144 - [Peter Hall](https://github.com/IamPete1):
145   - ***Vehicle***: Tailsitters
146   - ***Vehicle***: Sailboat
147   - ***Subsystem***: Scripting
148 - [Andy Piper](https://github.com/andyp1per):
149   - ***Subsystem***: Crossfire
150   - ***Subsystem***: ESC
151   - ***Subsystem***: OSD
152   - ***Subsystem***: SmartAudio
153 - [Alessandro Apostoli ](https://github.com/yaapu):
154   - ***Subsystem***: Telemetry
155   - ***Subsystem***: OSD
156 - [Rishabh Singh ](https://github.com/rishabsingh3003):
157   - ***Subsystem***: Avoidance/Proximity
158 - [David Bussenschutt ](https://github.com/davidbuzz):
159   - ***Subsystem***: ESP32,AP_HAL_ESP32
160 - [Charles Villard ](https://github.com/Silvanosky):
161   - ***Subsystem***: ESP32,AP_HAL_ESP32