Overview of the Source Bundle
=============================

.. warning::

  This section only applies to the |me| source bundle (``rti_connext_dds_micro-<version>-source.zip``). 
  For other bundles, refer to :ref:`section-host-bundle` and :ref:`section-target-bundle`.

When unzipped, the source bundle (``rti_connext_dds_micro-<version>-source.zip``) 
creates the following directory structure: 

.. code-block:: none

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

- The ``doc/`` directory contains this documentation, as well as the C and C++
  API References.
- 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.
- The ``src/`` directory contains the source files for all supported Platform Independent Libraries
  and Platform Support Libraries.
- CMakeLists.txt is the main input file to `CMake <https://cmake.org/>`_ and is used to 
  generate build files.
- ``ReadMe.html`` opens this documentation.