ArduPlane, ArduCopter, ArduRover, ArduSub source
Go to file
Andrew Tridgell 7d9e8c8d89 git: try to reduce the number of binary files added to the tree
our git tree has become far too large due to large exe, dll etc
files. We can't fully get rid of the ones that are there, but this may
discourage people from adding more
2012-04-30 22:47:08 +10:00
APMrover2 APMrover v2.0 - tested on Traxxas Monster Jam Grinder XL-5 3602 2012-04-30 09:17:14 +02:00
ArduBoat Fixed along track bug. 2011-12-07 20:55:06 -05:00
ArduCopter ArduCopter: fixed compile error by declaring extern print_latlon 2012-04-30 21:44:27 +09:00
ArduPlane more arduplane param info 2012-04-30 20:39:41 +08:00
ArduRover Added AP_Board to APO 2011-12-07 16:31:56 -05:00
Tools APM Planner 1.1.77 2012-04-30 20:07:14 +08:00
apo Added AP_Board to APO 2011-12-07 16:31:56 -05:00
archive more directories for the archive 2011-09-09 12:48:34 +10:00
cmake Worked on ArduCopter cmake options. 2012-04-19 16:05:08 -04:00
libraries AP_AHRS: updated default AHRS_YAW_P to 0.2 (was 0.4) 2012-04-30 17:29:45 +09:00
.gitignore git: try to reduce the number of binary files added to the tree 2012-04-30 22:47:08 +10:00
.project ArduPlane cmake build working. 2011-10-31 13:18:48 -04:00
COPYING.txt cmake overhaul, cleaned up readme, added license 2011-09-30 17:32:51 -04:00
Doxyfile.in Working on doxygen support. 2011-11-25 21:35:20 -05:00
README.txt Switched to project specific cmake lists. 2012-04-17 23:07:20 -04:00

README.txt

Building using arduino
--------------------------
To install the libraries:
 - copy Library Directories to your \arduino\hardware\libraries\ or arduino\libraries directory
 - Restart arduino IDE

 * Each library comes with a simple example. You can find the examples in menu File->Examples

Building using make 
-----------------------------------------------
 - go to directory of sketch and type "make".
 --type "make upload" to upload according to the parameters in config.mk .

Building using cmake
-----------------------------------------------
 - cd ArduPlane (ArduCopter etc ..)
 - mkdir build
 - cd build
 - cmake .. -DAPM_BOARD=mega -DAPM_PORT=/dev/ttyUSB0
    You can select from mega/mega2560.
    If you have arduino installed in a non-standard location you by specify it by using:
        -DARDUINO_SDK_PATH=/path/to/arduino ..
 - make (will build the sketch)
 - make ArduPlane-upload (will upload the sketch ArduPlane etc.)

    If you have a sync error during upload reset the board or power cycle the board
    before the upload starts.

 
Building using eclipse
-----------------------------------------------

    Getting the Source:

        assuming source located here: /home/name/apm-src
        You can either download it or grab it from git:
        git clone https://code.google.com/p/ardupilot-mega/ /home/name/apm-src

    Generating the Eclipse Project for Your System:
    
        mkdir /home/name/apm-build 
        cd /home/name/apm-build
        cmake -G"Eclipse CDT4 - Unix Makefiles" -D CMAKE_BUILD_TYPE=Debug ../apm-src -D BOARD=mega -D PORT=/dev/ttyUSB0

        Here apm-src can be any sketch, ArduPlane/ ArduCopter etc.

        Note: Unix can be substituted for MinGW/ MSYS/ NMake (for windows)
            (see http://www.vtk.org/Wiki/Eclipse_CDT4_Generator)

        input options:

            CMAKE_BUILD_TYPE choose from DEBUG, RELEASE etc.
            PORT is the port for uploading to the board, COM0 etc on windows. /dev/ttyUSB0 etc. on linux
            BOARD is your board type, mega for the 1280 or mega2560 for the 2560 boards.
            ARDUINO_SDK_PATH if it is not in default path can specify as /path/to/arduino
        
    Importing the Eclipse Build Project:

        Import project using Menu File->Import
        Select General->Existing projects into workspace:
        Browse where your build tree is and select the root build tree directory. 
        Keep "Copy projects into workspace" unchecked.
        You get a fully functional eclipse project

    Importing the Eclipse Source Project:
    
        You can also import the source repository (/home/name/apm-src) if you want to modify the source/ commit using git.

    Settings up Eclipse to Recognize PDE files:

         Window > Preferences > General > Content Types. This tree associates a
            filename or filename pattern with its content type so that tools can treat it
            properly. Source and header files for most languages are under the Text tree. 
            Add "*.pde" as a C++ Source.

	Autocompletion:
	
		Right click on source project -> Properties -> Project References -> apm-build Project
    
    Advanced:
    
        * Regenerating the eclipse source project file:
            cmake -G"Eclipse CDT4 - Unix Makefiles" -DECLIPSE_CDT4_GENERATE_SOURCE_PROJECT=TRUE /home/name/apm-src

Build a package using cpack
-----------------------------------------------
 - cd build
 - cmake ..
 - make package
 - make package_source


vim:ts=4:sw=4:expandtab