From 3f7bcee1d097dec5f3a43b78b007919689c19b19 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Fri, 29 Jan 2016 16:57:40 +1100 Subject: [PATCH] Add information on building for Windows --- docs/contributing/contribution_tool.rst | 34 ++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/docs/contributing/contribution_tool.rst b/docs/contributing/contribution_tool.rst index 62cddbc..a70e091 100644 --- a/docs/contributing/contribution_tool.rst +++ b/docs/contributing/contribution_tool.rst @@ -32,6 +32,8 @@ repository and contribute changes back to the project master branch using pull r Building the Tool ================= +DroneKit-LA is built in the same way on all platforms; by cloning the repository and then calling ``make`` in its root directory. The only differences are in the dependencies required to build on each platform. + Building using Vagrant ---------------------- @@ -55,7 +57,7 @@ commands to do so on Linux would be: sudo easy_install -U pip sudo pip install sphinx sphinx-3dr-theme -To build you just clone the repository and call *make* from its root: +To build *dronekit-la*, you can then just clone the repository and call *make* from its root: .. code-block:: bash @@ -82,8 +84,34 @@ To build *dronekit-la*, you can then just clone the repository and call *make* f # Build the tool make - - + + +Building on Windows +------------------- + +You can build *dronekit-la* natively on Windows from within `Cygwin `_. + +First set up the dependencies: + +* `Download and install Cygwin `_ (install for all users) +* Install the following packages: + + * Devel / git + * Devel / make + * Devel / mingw64-x86_64-gcc-g++ + +* Open the *Cygwin Terminal* + +To build *dronekit-la*, you can then just clone the repository and call *make* from its root: + +.. code-block:: bash + + # Get the repo + git clone https://github.com/dronekit/dronekit-la.git + cd dronekit-la + + # Build the tool + make .. _contributing-test-code: