.. SPDX-FileCopyrightText: Copyright contributors to the poco project.
.. SPDX-License-Identifier: MIT

========================
poco - Pocket Coroutines
========================

This documentation covers the basics of using poco within your application.

A good place to start is the :ref:`quick-start:Quick Start`.

To get a taste of what poco is about, see the tutorials.

To get details about specific features and how to use them, refer to the User Manual
pages, or the API.

For extending poco or developing custom schedulers or primitives, consult the
Internals section relating to the operational design.

.. toctree::
    :caption: User Manual
    :hidden:

    quick-start.md
    general
    result-codes.md
    operation
    events
    queues
    streams
    mutex
    semaphore
    Porting Platforms<platform.md>

.. toctree::
    :caption: Tutorials
    :hidden:

    tutorials/hello-world.rst

.. toctree::
    :caption: API
    :hidden:

    API Reference<_gen/filelist>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`