Tools: install-prereqs-ubuntu.sh: add support for Ubuntu Noble (24.04)
[ardupilot.git] / README.md
blob2121f8f21fdf646629a51a1c54100d774b7c018d
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%20and%20sitl%20building/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 - [Michael du Breuil](https://github.com/WickedShell):
100   - ***Subsystem***: Batteries
101   - ***Subsystem***: GPS
102   - ***Subsystem***: Scripting
103 - [Peter Barker](https://github.com/peterbarker):
104   - ***Subsystem***: DataFlash, Tools
105 - [Randy Mackay](https://github.com/rmackay9):
106   - ***Vehicle***: Copter, Rover, AntennaTracker
107 - [Siddharth Purohit](https://github.com/bugobliterator):
108   - ***Subsystem***: CAN, Compass
109   - ***Board***: Cube*
110 - [Tom Pittenger](https://github.com/magicrub):
111   - ***Vehicle***: Plane
112 - [Bill Geyer](https://github.com/bnsgeyer):
113   - ***Vehicle***: TradHeli
114 - [Emile Castelnuovo](https://github.com/emilecastelnuovo):
115   - ***Board***: VRBrain
116 - [Georgii Staroselskii](https://github.com/staroselskii):
117   - ***Board***: NavIO
118 - [Gustavo José de Sousa](https://github.com/guludo):
119   - ***Subsystem***: Build system
120 - [Julien Beraud](https://github.com/jberaud):
121   - ***Board***: Bebop & Bebop 2
122 - [Leonard Hall](https://github.com/lthall):
123   - ***Subsystem***: Copter attitude control and navigation
124 - [Matt Lawrence](https://github.com/Pedals2Paddles):
125   - ***Vehicle***: 3DR Solo & Solo based vehicles
126 - [Matthias Badaire](https://github.com/badzz):
127   - ***Subsystem***: FRSky
128 - [Mirko Denecke](https://github.com/mirkix):
129   - ***Board***: BBBmini, BeagleBone Blue, PocketPilot
130 - [Paul Riseborough](https://github.com/priseborough):
131   - ***Subsystem***: AP_NavEKF2
132   - ***Subsystem***: AP_NavEKF3
133 - [Víctor Mayoral Vilches](https://github.com/vmayoral):
134   - ***Board***: PXF, Erle-Brain 2, PXFmini
135 - [Amilcar Lucas](https://github.com/amilcarlucas):
136   - ***Subsystem***: Marvelmind
137 - [Samuel Tabor](https://github.com/samuelctabor):
138   - ***Subsystem***: Soaring/Gliding
139 - [Henry Wurzburg](https://github.com/Hwurzburg):
140   - ***Subsystem***: OSD
141   - ***Site***: Wiki
142 - [Peter Hall](https://github.com/IamPete1):
143   - ***Vehicle***: Tailsitters
144   - ***Vehicle***: Sailboat
145   - ***Subsystem***: Scripting
146 - [Andy Piper](https://github.com/andyp1per):
147   - ***Subsystem***: Crossfire
148   - ***Subsystem***: ESC
149   - ***Subsystem***: OSD
150   - ***Subsystem***: SmartAudio
151 - [Alessandro Apostoli ](https://github.com/yaapu):
152   - ***Subsystem***: Telemetry
153   - ***Subsystem***: OSD
154 - [Rishabh Singh ](https://github.com/rishabsingh3003):
155   - ***Subsystem***: Avoidance/Proximity
156 - [David Bussenschutt ](https://github.com/davidbuzz):
157   - ***Subsystem***: ESP32,AP_HAL_ESP32
158 - [Charles Villard ](https://github.com/Silvanosky):
159   - ***Subsystem***: ESP32,AP_HAL_ESP32