E6000r Remote PHY Shelf Files

===================================================================

                Building rphy_shelf_freertos Software

===================================================================

Build Environment
-----------------
The expected setup and build environment is Ubuntu Linux version 16.04.
Please note that environment setup steps could vary for later Ubuntu
versions with changes to the Ubuntu package manager.

Required software
-----------------
  - CMake 3.0.0 or newer
  - clang compiler 3.9
  - python-crcmod
  - doxygen
  - GCC ARM Embedded toolchain version 5.4 2016q2

Installing cmake, clang, python-crcmod, and doxygen
---------------------------------------------------
* From Ubuntu command line, run the following:
  $ sudo apt-get install cmake clang-3.9 lldb-3.9 python-crcmod doxygen

Installing GCC Arm Embedded toolchain version 5.4 2016q2
--------------------------------------------------------
* Visit the following URL:
  https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads

* Download the GCC Arm Embedded toolchain 5-2016-q2-update uploaded
  on June 27th 2016 for Linux 32-bit.

* Using the Ubuntu command line, cd to the location the toolchain
  tarball was downloaded to.

* Copy the tarball to /opt:
  * $ sudo cp gccarmnoneeabi542016q220160622linuxtar.bz2 /opt

* $ cd /opt

* Extract the downloaded tarball and install the toolchain:
  * $ sudo tar -xvf gccarmnoneeabi542016q220160622linuxtar.bz2
  * $ cd gcc-arm-none-eabi-5_4-2016q2
  * $ sudo ln -s arm-none-eabi/ usr
  * $ sudo apt-get update && sudo apt-get upgrade
  * $ export PATH=/usr/bin:$PATH

Building rphy_shelf_freertos
----------------------------
* cd to the root of the untarred rphy_shelf_freertos directory

* $ mkdir build && cd build

* $ cmake -DCMAKE_TOOLCHAIN_FILE=../toolchains/clang-arm.cmake ../src/

* $ make