inav/docs/development/Building in Mac OS X.md

Building in Mac OS X

Building in Mac OS X can be accomplished in just a few steps:

• Install general development tools (clang, make, git)
• Install ARM GCC 7.2 series compiler or higher
• Checkout INAV sourcecode through git
• Build the code

Install general development tools (clang, make, git)

Open up a terminal and run make. If it is installed already, you should see a message like this, which means that you already have the required development tools installed:

make: *** No targets specified and no makefile found.  Stop.

If it isn't installed yet, you might get a popup like this. If so, click the "install" button to install the commandline developer tools:

If you just get an error like this instead of a helpful popup prompt:

-bash: make: command not found

Try running xcode-select --install instead to trigger the popup.

If that doesn't work, you'll need to install the XCode development environment from the App Store. After installation, open up XCode and enter its preferences menu. Go to the "downloads" tab and install the "command line tools" package.

Install ARM GCC 7.2 series or higher compiler

INAV is built using series 7.2 or above GCC compiler provided by the GNU Tools for ARM Embedded Processors project.

Grab the Mac installation tarball for the latest version in the 7.2 series or above (e.g. gcc-arm-none-eabi-7-2017-q4-major-mac.tar.bz2). Move it somewhere useful such as a ~/development folder (in your home directory) and double click it to unpack it. You should end up with a folder with a name similar to ~/development/gcc-arm-none-eabi-7-2017-q4-major/.

Now you just need to add the bin/ directory from inside the GCC directory to your system's path. Run nano ~/.profile. Add a new line at the end of the file which adds the path for the bin/ folder to your path, like so:

export PATH=$PATH:~/development/gcc-arm-none-eabi-7-2017-q4-major/bin

Press CTRL+X to exit nano, and answer "y" when prompted to save your changes.

Now close this terminal window and open a new one. Try running:

arm-none-eabi-gcc --version

You should get output similar to (in this example compiler series 7.2.1 is used):

arm-none-eabi-gcc (GNU Tools for Arm Embedded Processors 7-2017-q4-major) 7.2.1 20170904 (release) [ARM/embedded-7-branch revision 255204]
Copyright (C) 2017 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

If arm-none-eabi-gcc couldn't be found, go back and check that you entered the correct path in your ~/.profile file.

Ruby

Ruby is installed by default on macOS.

Checkout INAV sourcecode through git

Enter your development directory and clone the INAV repository using the "HTTPS clone URL" which is shown on the right side of the INAV GitHub page, like so:

git clone https://github.com/iNavFlight/inav

This will download the entire INAV repository for you into a new folder called "inav".

Build the code

Enter the inav directory and run make TARGET=SPRACINGF3 to build firmware for the SPRacing F3. When the build completes, the .hex firmware should be available as obj/inav_x.x.x_SPRACINGF3.hex for you to flash using the INAV Configurator.

Updating to the latest source

If you want to erase your local changes and update to the latest version of the INAV source, enter your inav directory and run these commands to first erase your local changes, fetch and merge the latest changes from the repository, then rebuild the firmware:

git reset --hard
git pull

make clean TARGET=SPRACINGF3
make TARGET=SPRACINGF3