CONTRIBUTING.md

   1 # How to build from source?\r
   2 \r
   3 Both development environment and GCS are supported on Windows, Linux and Mac OS X.\r
   4 \r
   5 # Install prerequisites\r
   6 \r
   7 The first step is to Install all OS specific prerequisites.\r
   8 \r
   9 ## Mac OS X\r
  10 \r
  11 Install XCode and its relatated command line tools (follow Apple documentation). Install git, curl and p7zip.\r
  12 \r
  13 You can use brew with `brew install git curl p7zip` or macport with `sudo port install git curl p7zip`.\r
  14 \r
  15 \r
  16 ## Ubuntu\r
  17 \r
  18     sudo apt-get install git build-essential curl gdb wget debhelper p7zip-full unzip flex bison libsdl1.2-dev libudev-dev libusb-1.0-0-dev libc6-i386 mesa-common-dev\r
  19 \r
  20 \r
  21 ## Windows\r
  22 \r
  23 ### Install [Msys2](https://msys2.github.io/)\r
  24 \r
  25 Follow the instructions on the web site. You can either install the i686 (Win32) or x86_64 (Win64) version.\r
  26 It is recommended to go for the Win64 Shell if possible.\r
  27 The x86_64 version has both Win32 and Win64 shells and it is possible to build both i686 and x86_64 applications.\r
  28 \r
  29 ### Add the LibrePilot MinGW package repository\r
  30 \r
  31 Add the following lines at the end of your /etc/pacman.conf file:\r
  32 \r
  33     [librepilot-mingw]\r
  34     SigLevel = Optional TrustAll\r
  35     Server = http://download.librepilot.org/repo/mingw\r
  36 \r
  37 ### Install required packages\r
  38 \r
  39 #### For i686 applications\r
  40 \r
  41 Start a MinGW-w64 Win64 Shell or a MinGW-w64 Win32 Shell.\r
  42 \r
  43     pacman -Sy\r
  44     pacman -S --needed git unzip tar mingw-w64-i686-toolchain mingw-w64-i686-ccache mingw-w64-i686-ntldd mingw-w64-i686-qt5 mingw-w64-i686-SDL mingw-w64-i686-mesa mingw-w64-i686-openssl mingw-w64-i686-gdal-minimal mingw-w64-i686-OpenSceneGraph mingw-w64-i686-osgearth\r
  45 \r
  46 Optionally install debug packages:\r
  47 \r
  48     pacman -S --needed mingw-w64-i686-OpenSceneGraph-debug mingw-w64-i686-osgearth-debug\r
  49 \r
  50 #### For x86_64 applications\r
  51 \r
  52 Start a MinGW-w64 Win64 Shell.\r
  53 \r
  54     pacman -Sy\r
  55     pacman -S --needed git unzip tar mingw-w64-x86_64-toolchain mingw-w64-x86_64-ccache mingw-w64-x86_64-ntldd mingw-w64-x86_64-qt5 mingw-w64-x86_64-SDL mingw-w64-x86_64-mesa mingw-w64-x86_64-openssl mingw-w64-x86_64-gdal-minimal mingw-w64-x86_64-OpenSceneGraph mingw-w64-x86_64-osgearth\r
  56 \r
  57 Optionally install debug packages:\r
  58 \r
  59     pacman -S --needed mingw-w64-x86_64-OpenSceneGraph-debug mingw-w64-x86_64-osgearth-debug\r
  60 \r
  61 **NOTE** On Windows you need to run the mingw version of make, which is `mingw32-make`\r
  62 \r
  63 \r
  64 # Setup the build environment and build\r
  65 \r
  66 The `all_sdk_install` target will automatically retrieve and install all needed tools (qt, arm gcc, etc.) in a local folder `/path/to/LibrePilot_root/tools`\r
  67 \r
  68 ## Ubuntu / Mac OS X\r
  69 \r
  70     make all_sdk_install\r
  71     make package\r
  72 \r
  73 ## Windows\r
  74 \r
  75     mingw32-make all_sdk_install\r
  76     mingw32-make package\r
  77 \r
  78 The `package` target will build the complete installable package for the current platform.\r
  79 \r
  80 You can build the `all` target to just build the software.\r
  81 \r
  82 Run `make` with no arguments to show the complete list of supported targets.\r