.. _getting_started:

Getting Started
===============

The ``gcovr`` command provides a summary of the lines that have been
executed in a program.  Code coverage statistics help you discover
untested parts of a program, which is particularly important when
assessing code quality.  Well-tested code is a characteristic of
high quality code, and software developers often assess code coverage
statistics when deciding if software is ready for a release.

.. include:: ../../README.rst
   :start-after: .. begin quickstart
   :end-before: .. end quickstart

What to read next
-----------------

The :ref:`guide` explains how to use the features of gcovr.
In particular:

* :ref:`compiling`
* :ref:`output_formats`
* :ref:`filters`

The :ref:`manpage` provides an overview of all options.

Specific problems might be addressed in the :ref:`cookbook` or the :ref:`faq`.