##########################
Elk Audio OS documentation
##########################

.. toctree::
   :maxdepth: 1
   :hidden:

   Getting started <intro/index>
   Sushi reference <sushi/index>
   Embedded OS reference <embedded/index>
   Legacy documentation <legacy/index>

**Useful links**:
`Main website <https://elk.audio/start>`_ |
`Github Repositories <https://github.com/elk-audio>`_ |
`Forum <https://forum.elk.audio>`_

Elk Audio OS is a fully-featured embedded Linux distribution optimized for low-latency audio applications. It is currently used by companies making professional audio products, audio enthusiasts building their own devices, and serves as the core of Elk's own `Elk Live <https://elk.live>`_ online music collaboration tool.

The core audio plugin host, Sushi, is also available as an independent application for macOS and Linux, and can be used as a flexible programming environment for building other kind of audio applications for those platforms.

Since the release of Elk Audio OS 1.0, we are focusing on giving open support only for Sushi and for the image running on Raspberry Pi 4 with HiFiBerry and the RPi audio hats. The previous documentation on other development kits and features (e.g. the Elk Pi board) is now available under the "Legacy Documentation" section in this page.

.. grid:: 2

    .. grid-item-card::

        About Elk Audio OS
        ^^^^^^^^^^^^^^^^^^
        
        Do you want to find out more about Elk Audio OS? Check out why it could be useful for you, and what are the supported hardware platforms and the licensing options for both open-source and commercial applications.

        +++

        .. button-ref:: intro/how_elk_works
            :expand:
            :color: secondary
            :click-parent:

            How Elk works

    .. grid-item-card::

        Getting Started on your computer
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        You only need a macOS or Linux computer to try out Elk's most important part, its audio engine Sushi, and get an idea of how making products for Elk feels like.

        +++

        .. button-ref:: intro/getting_started_with_development_kit_software
            :expand:
            :color: secondary
            :click-parent:

            Get Sushi for your computer

    .. grid-item-card::

        Getting Started on Raspberry Pi 4
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        If you want to try out the low-latency performance of Elk on embedded hardware, the easiest is to start with one of the prebuilt images that we provide for the Raspberry Pi 4 Single board computers.

        +++

        .. button-ref:: intro/getting_started_with_raspberry
            :expand:
            :color: secondary
            :click-parent:

            Run Elk on RPi4

    .. grid-item-card::

        Sushi reference
        ^^^^^^^^^^^^^^^
        
        Want to dig more into Sushi's processing capabilities and how to control them? Check out the detailed reference on Elk's audio engine.

        +++

        .. button-ref:: sushi/index
            :expand:
            :color: secondary
            :click-parent:

            Sushi reference documentation