From 83bbb27b831f5553c5bb073877eb6046cd9a4258 Mon Sep 17 00:00:00 2001 From: Philippe Renon Date: Fri, 22 Jan 2016 22:50:18 +0100 Subject: [PATCH] prettyfy CONTRIBUTING.MD --- CONTRIBUTING.md | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56ba98fc4..3d6d41a7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,46 +8,51 @@ The first step is to Install all OS specific prerequisites. ### Mac OS X -Install XCode and its relatated command line tools (follow Apple documentation). -Install git, curl and p7zip. You can use brew `brew install git curl p7zip` or macport: `sudo port install git curl p7zip` +Install XCode and its relatated command line tools (follow Apple documentation). Install git, curl and p7zip. + +You can use brew with `brew install git curl p7zip` or macport with `sudo port install git curl p7zip`. ### Ubuntu - 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 + 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 ### Windows -Install [Msys2](https://msys2.github.io/) following the instructions on the web site. You can either install the i686 (32 bit) or x86_64 (64 bit) version. +Install [Msys2](https://msys2.github.io/) following the instructions on the web site. You can either install the i686 (32 bit) or x86_64 (64 bit) version. -Start a "MinGW-w64 Win32 Shell" or "MinGW-w64 Win32 Win64 Shell" (NOT "MSYS2 Shell") +Start a *MinGW-w64 Win32 Shell* or *MinGW-w64 Win64 Shell* (but **not** a *MSYS2 Shell*). -Install the dependent packages (32 bit): +Install the dependent packages that match your MinGW shell. - pacman -S --needed git unzip tar mingw-w64-i686-toolchain mingw-w64-i686-qt5 mingw-w64-i686-SDL mingw-w64-i686-mesa mingw-w64-i686-openssl +For 32 bit: -Or for a 64 bit build: + pacman -S --needed git unzip tar mingw-w64-i686-toolchain mingw-w64-i686-qt5 mingw-w64-i686-SDL mingw-w64-i686-mesa mingw-w64-i686-openssl - pacman -S --needed git unzip tar mingw-w64-x86_64-toolchain mingw-w64-x86_64-qt5 mingw-w64-x86_64-SDL mingw-w64-x86_64-mesa mingw-w64-x86_64-openssl +For 64 bit: -*NOTE* On Windows you need to run the mingw version of make, which is 'mingw32-make' + pacman -S --needed git unzip tar mingw-w64-x86_64-toolchain mingw-w64-x86_64-qt5 mingw-w64-x86_64-SDL mingw-w64-x86_64-mesa mingw-w64-x86_64-openssl` + +**NOTE** On Windows you need to run the mingw version of make, which is `mingw32-make` ## Setup the build environment and build -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` +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` ### Ubuntu / Mac OS X - make all_sdk_install - make package + make all_sdk_install + make package ### Windows - mingw32-make all_sdk_install - mingw32-make package + mingw32-make all_sdk_install + mingw32-make package -The `package` target will build the complete installable package for the current platform. You can build the 'all' target to just build the software. +The `package` target will build the complete installable package for the current platform. -Run make with no arguments to show the complete list of supported targets. +You can build the `all` target to just build the software. + +Run `make` with no arguments to show the complete list of supported targets.