ArduPlane, ArduCopter, ArduRover, ArduSub source
Go to file
Jason Short 81a4c87576 lengthened log timeout 2011-11-19 17:31:36 -08:00
ArduBoat Updated date on file. 2011-11-01 13:59:34 -04:00
ArduCopter Logging stabilization KP to hunt bug 2011-11-19 16:59:54 -08:00
ArduPlane Rev version number 2011-11-19 23:43:47 +00:00
ArduRover Obstacle avoidance moved from AP_Guide to ControllerCar (works only for cars for now), algorithm changed 2011-11-01 19:09:57 +01:00
Tools lengthened log timeout 2011-11-19 17:31:36 -08:00
apo Switching to new eclipse project style. 2011-10-30 22:57:34 -04:00
archive more directories for the archive 2011-09-09 12:48:34 +10:00
cmake Added cpack packaging, ArduRover/ArduBoat/apo, building with cmake 2011-09-30 20:24:02 -04:00
libraries desktop: added support for new DataFlash functions 2011-11-18 17:50:12 +11:00
.gitignore Ignored swap files. 2011-10-27 17:32:00 -04:00
.project ArduPlane cmake build working. 2011-10-31 13:18:48 -04:00
CMakeLists.txt 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
README.txt Fixed autocompletion for eclipse project. 2011-10-31 01:28:52 -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.

Building using cmake
-----------------------------------------------
 - mkdir build
 - cd build
 - cmake ..
 - make (will build every sketch)
 - make ArduPlane (will build just ArduPlane etc.)
 
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

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

        PORT is the port for uploading to the board, COM0 etc on windows.
        BOARD is your board type, mega for the 1280 or mega2560 for the 2560 boards.
    
    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