Commits

Thayne Harbaugh committed 2357490

Add initial documentation

Comments (0)

Files changed (1)

+================
+ TI-OVERO-TOOLS
+================
+
+This is a set of tools for developing to TI's Overo ARM+DSP product.
+
+
+ti-setup-dvsdk
+==============
+
+This tool downloads, unpacks and configures TI's DVSDK tool chain.  It is
+able to work with TI's Code Sourcery tool chain, OpenEmbedded tool chain or
+the Linaro tool chain.
+
+It is completely feasible to use ``ti-setup-dvsdk`` to create multiple tool
+chain environments.  Utilization of a particular installation is selected
+by sourcing the ``environment.sh`` file in the installation top directory
+and then building source code.
+
+While there are certain internal checks performed, large verifications are
+not performed on the installation of OpenEmbedded or Linaro tools.  There
+is, however, a test compile stage performed on TI's included source which
+should demonstrate correct functionality of the installed libraries and
+tool chain.
+
+SYNOPSIS
+~~~~~~~~
+
+./ti-setup-dvsdk [OPTIONS]
+
+
+OPTIONS
+~~~~~~~
+
+-d DIR          Installation directory (required)
+-D              Download only - do not install
+-h              Print (this) usage information
+-l EXE          Linaro gcc executable (full path)
+-o DIR          OpenEmbedded directory
+-t              Test TI SDK after installation
+-u URL          URL prefix for fetching packages
+-x              Enable debug output
+-y              Accept license agreements
+
+
+HOW IT WORKS
+~~~~~~~~~~~~
+
+``ti-setup-dvsdk`` will install to ``-d DIR`` the TI DVSDK.  It will
+remotely fetch and cache all of the components from TI into
+``DIR/downloads``.  These downloaded files can be re-used if a
+re-installation is initiated.  Each time a SDK package is downloaded it
+will be unpacked to ``DIR``.  These package files cached in ``DIR/download`
+can be copied to a local directory or URL on the local network.  Subsequent
+invocations for ``ti-setup-dvsdk`` can then us ``-u URL`` to point to the
+local repository so that the packages do not need to be fetched from TI.
+
+
+Installing with Code Sourcery Tool Chain
+----------------------------------------
+
+$> ./ti-setup-dvsdk -d /some/path/ti-cs
+
+
+Installing with OpenEmbedded Tool Chain
+---------------------------------------
+
+$> ./ti-setup-dvsdk -d /some/path/ti-cs -o /some/path/to/openembedded
+
+The OpenEmbedded location must have the tool chain already built for this
+to work.
+
+
+Installing with Linaro Tool Chain
+---------------------------------------
+
+$> ./ti-setup-dvsdk -d /some/path/ti-cs -l /some/path/to/bin/linaro-gcc
+
+The path passed to the ``-l EXE`` argument must be the Linaro gcc
+compiler - all other tools for the tool chain will be inferred from this.
+
+
+Testing
+-------
+
+Passing the ``-t`` argument will cause the tool chain to be exercised by
+compiling the TI DVSDK sample code.  Any failure in this process is notable
+and is a likely indication that the tool chain installation will not work
+for development.