ardupilot/README.md

62 lines
2.1 KiB
Markdown
Raw Normal View History

2013-01-14 18:46:48 -04:00
# ArduPilot Project
2013-01-14 18:46:48 -04:00
## Getting the source
2013-01-14 18:46:48 -04:00
You can either download the source using the "ZIP" button at the top of the
github page, or you can make a clone using git:
```
git clone git://github.com/diydrones/ardupilot.git
```
2013-01-14 18:46:48 -04:00
## Building using Arduino IDE
2013-01-14 18:46:48 -04:00
ArduPilot is no longer compatible with the standard Arduino distribution.
You need to use a patched Arduino IDE to build ArduPilot.
2013-01-14 18:46:48 -04:00
1. The patched ArduPilot Arduino IDE is available for Mac and Windows from
the [downloads page][1]. On Linux, you should use the makefile build.
2013-01-14 18:46:48 -04:00
2. Unpack and launch the ArduPilot Arduino IDE. In the preferences menu, set
your sketchbook location to your downloaded or cloned `ardupilot` directory.
2013-01-14 18:46:48 -04:00
3. In the ArduPilot Arduino IDE, select your ArduPilot type (APM1 or APM2) from
the ArduPilot menu (in the top menubar).
2013-01-14 18:46:48 -04:00
4. Restart the ArduPilot Arduino IDE. You should now be able to build ArduPlane
or ArduCopter from source.
2013-01-14 18:46:48 -04:00
5. Remember that, after changing ArduPilot type (APM1 or APM2) in the IDE,
you'll need to close and restart the IDE before continuing.
2013-01-14 18:46:48 -04:00
[1]: http://code.google.com/p/ardupilot-mega/downloads/list
2013-01-14 18:46:48 -04:00
## Building using make
2013-01-14 18:46:48 -04:00
1. Before you build the project for the first time, you'll need to run
`make configure` from a sketch directory. This will create a `config.mk`
file at the top level of the repository. You can set some defaults in
`config.mk`
2013-01-14 18:46:48 -04:00
2. In the sketch directory, type `make` to build for APM2. Alternatively,
`make apm1` will build for the APM1.
2013-01-14 18:46:48 -04:00
3. Type `make upload` to upload. You may need to set the correct default
serial port in your `config.mk`.
2013-01-14 18:46:48 -04:00
# User Technical Support
2013-01-14 18:46:48 -04:00
ArduPilot users should use the DIYDrones.com forums for technical support.
2013-01-14 18:46:48 -04:00
# Development Team
2013-01-14 18:46:48 -04:00
The ArduPilot project is open source and maintained by a team of volunteers.
2013-01-14 18:46:48 -04:00
To contribute, you can send a pull request on Github. You can also join the
[development discussion on Google Groups][2]. Note that the Google Groups
mailing lists are NOT for user tech support, and are moderated for new users to
prevent off-topic discussion.
2013-01-14 18:46:48 -04:00
[2]: https://groups.google.com/forum/?fromgroups#!forum/drones-discuss