.. _section-host-bundle:

Overview of the Host Bundle
===========================

This section provides an overview of the host package contents, as well as the 
resultant directory structure in the |me| installation. 

When installed, the host bundle (``rti_connext_dds_micro-<version>-host.rtipkg``) 
adds the following to the |me| directory:

.. code-block:: none

  --rti_connext_dds-<version>/
    |
    +--rti_connext_dds_micro-<version>/
        |--doc/
        |--example/
        |--include/
        |--resource/
        |--rtiddsgen/
        |--rtiddsmag/
        |--CMakeLists.txt
        |--ReadMe.html
        +--src/
           +--rti_me_psl

- The ``doc/`` directory contains this documentation, as well as the C and C++
  API References.
- The ``example/`` directory contains buildable example applications, as well as
  instructions on how to build and run them.
- The ``include/`` directory contains the public header files to compile applications.
- The ``resource/`` directory contains the build system used for the examples
  and Platform Support Libraries (PSL).
- The ``rtiddsgen/`` directory contains an IDL compiler for type support code.
- The ``rtiddsmag/`` directory contains a tool for generating application code
  from XML descriptions.
- CMakeLists.txt is the main input file to `CMake <https://cmake.org/>`_ and is used to 
  generate build files.
- ``ReadMe.html`` opens this documentation.
- ``src/`` contains the source files for all supported Platform Support 
  Libraries (PSL); refer to :ref:`section-target-bundle` for more information on
  the PSL. These can be recompliled for specific platform 
  configurations, as described in :ref:`psl_compiling`.