.. _Get_Started_Guide

Get Started with |full_name|
==============================

.. include:: /GSG/intro_gsg.rst

oneTBB is available as a stand-alone product and as part of the |base_tk|.

System Requirements
*******************

Refer to the `oneTBB System Requirements <https://software.intel.com/content/www/us/en/develop/articles/intel-oneapi-threading-building-blocks-system-requirements.html>`_.


Download Intel(R) oneAPI Threading Building Blocks (oneTBB)
***********************************************************

Download |short_name| as a `stand-alone product <https://software.intel.com/content/www/us/en/develop/articles/oneapi-standalone-components.html#onetbb>`_ 
or as a part of the `Intel(R) oneAPI Base Toolkit <https://software.intel.com/content/www/us/en/develop/tools/oneapi/base-toolkit/download.html>`_.
See Installation Guide for a stand-alone version (:doc:`Windows* OS <installation_guide_windows>` and :doc:`Linux* OS <installation_guide_linux>`) and 
`Intel(R) oneAPI Toolkits Installation Guide <https://www.intel.com/content/www/us/en/developer/articles/guide/installation-guide-for-oneapi-toolkits.html>`_. 


.. include:: /GSG/before_beginning_and_example.rst


|full_name| and pkg-config tool
******************************

The pkg-config tool is used to simplify the compilation line by retrieving information about packages
from special metadata files. It helps avoid large hard-coded paths and makes compilation more portable.


Compile a program using pkg-config
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To compile a test program test.cpp with oneTBB on Linux* OS and macOS*, 
provide the full path to search for include files and libraries, or provide a simple line like this: 

.. code::
   
   g++ -o test test.cpp $(pkg-config --libs --cflags tbb)

Where:

``--cflags`` provides oneTBB library include path:

.. code::

   $ pkg-config --cflags tbb``
   -I<path-to>/tbb/latest/lib/pkgconfig/../..//include

``--libs`` provides the Intel(R) oneTBB library name and the search path to find it:

.. code::
   
   $ pkg-config –libs tbb
	-L<path to>tbb/latest/lib/pkgconfig/../..//lib/intel64/gcc4.8 -ltbb

.. note::

   For Windows* OS, additionally use the ``--msvc-syntax`` option flag that converts the compiling and linking flags in an appropriate mode.



.. toctree::
   :maxdepth: 1
   :hidden:
   
   installation_guide_windows
   installation_guide_linux
   


Find more
*********

.. list-table:: 
   :widths: 40 60
   :header-rows: 0


   * - 
	   - `oneTBB Community Forum <https://community.intel.com/>`_
	   - `Product FAQs <https://software.intel.com/content/www/us/en/develop/support/faq-product.html>`_
	   - `Support requests <https://software.intel.com/content/www/us/en/develop/articles/how-to-create-a-support-request-at-online-service-center.html>`_
     - Use these resources if you need support with oneTBB.
   
   * - `Release Notes <https://software.intel.com/content/www/us/en/develop/articles/intel-oneapi-threading-building-blocks-release-notes.html>`_
     - Find up-to-date information about the product, including detailed notes, known issues, and changes.
   
   * - `Documentation <https://software.intel.com/content/www/us/en/develop/documentation/onetbb-documentation/top.html>`_: `Developer Guide <https://software.intel.com/content/www/us/en/develop/documentation/onetbb-documentation/top/onetbb-developer-guide.html>`_ and `API Reference <https://software.intel.com/content/www/us/en/develop/documentation/onetbb-documentation/top/onetbb-api-reference.html>`_
     - Learn to use oneTBB.   
   * - `GitHub* <https://github.com/oneapi-src/oneTBB>`_
     - Find oneTBB implementation in open source.
   

Notices and Disclaimers
***********************

Intel technologies may require enabled hardware, software or service activation.

No product or component can be absolutely secure.

Your costs and results may vary.

© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks
of Intel Corporation or its subsidiaries. Other names and brands may be claimed
as the property of others.

No license (express or implied, by estoppel or otherwise) to any intellectual
property rights is granted by this document.

The products described may contain design defects or errors known as errata which
ay cause the product to deviate from published specifications. Current
characterized errata are available on request.

Intel disclaims all express and implied warranties, including without limitation,
the implied warranties of merchantability, fitness for a particular purpose,
and non-infringement, as well as any warranty arising from course of performance,
course of dealing, or usage in trade.