Build using the Install Script
====================================

As of release v8.16 there is an "install" script which can automate the build steps.

To automatically build the driver and executables in-place:

.. code-block:: console

  $ ./install

To build the driver and executables and then install the BitFlow executables and libraries in "well-known" places:

.. code-block:: console

  $ sudo ./install TARG_BF=/usr/local/bf \
                 TARG_MOD=/usr/local/mod \
                 TARG_LIB=/usr/local/lib \
                 TARG_BIN=/usr/local/bin \
                 TARG_INC=/usr/local/inc

The "sudo" is necessary since most users do not have write permission in the
/usr/local area.

The install script generates information which removes the need for setting
the **BITFLOW_INSTALL_DIRS** environment variable.  If set this environment
variable always overrides the install script information.

If the TARG_LIB=/usr/local/lib is used then it will be necessary to run

.. code-block:: console

  $ sudo ldconfig

after the installation in order for the run-time loader to find the BitFlow
shared object libraries.  If this is done then the **LD_LIBRARY_PATH** environment
variable should not be needed to access the BitFlow shared object library.

When necessary the install script will generate a "**uninstall_bitflow_X.XX**" script which can remove any files and directories copied or created by the install script.

Uninstall with:

.. code-block:: console

  $ sudo uninstall_bitflow_X.XX

where the X.XX is the SDK release version.

.. note:: The uninstall script is only generated when the install script is forced to install files into different directories. If everything is built in-place, then just deleting the "$BITFLOW_INSTALL_DIR" directory will remove all files.