resources Documentation
==============================

*resources* provides a suite of tools to manage/manipulate and deliver resources for Carbon titles.

See :doc:`installation` section for further installation information.

.. list-table:: Key term cheatsheet
   :widths: 25 75
   :header-rows: 1

   * - Term
     - Description
   * - Resource Group
     - A text data file which contains information regarding a group of resources.
   * - Bundle Resource Group
     - An extended Resource Group containing extra information related to bundling.
   * - Patch Resource Group
     - An extended Resource Group containing extra information related to patching.
   * - Bundle
     - A collection of resources split into binary chunks and accompanied with a Bundle Resource Group containing related meta data.
   * - Chunk
     - A single binary file made up of split resources. Many chunks together make a bundle.
   * - Patch
     - A collection of patch binaries and accompanied with a Patch Resource Group containing related meta data.

Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   tools
   overviewDocuments
   quickStart
   guides
   designDocuments

.. note::

   This project is under active development.