..
   SPDX-License-Identifier: GPL-3.0-only
   This file is part of Lazuli.

.. sectionauthor::
   Copyright (c) 2020, Remi Andruccioli <remi.andruccioli@gmail.com>

Welcome to Lazuli's documentation!
==================================

You are reading the documentation of the Lazuli project.

The project is hosted at `<https://github.com/randruc/Lazuli>`_

This documentation is divided in two parts: **User** and **Kernel**.

The **User** documentation is intended for end users, who wish to develop
real-time systems and applications using the Lazuli kernel.
This documentation will guide you through the process of getting Lazuli sources,
setting up a working development environment, and compiling your code with
Lazuli. It will also give you detailed information about the functionalities
provided by Lazuli.

The last chapter of this documentation is the **Kernel** documentation.
It is intended for programmers, who wish to code in the Lazuli kernel, hacking
and improving it.
This documentation will give you detailed information about the inner working
of Lazuli.

.. toctree::
   :numbered:
   :maxdepth: 2

   introduction
   a_simple_example
   getting_lazuli
   set_up_environment
   developing_your_project
   kernel/kernel_documentation
   glossary

If you wish to read the API documentation, please browse to
`<https://randruc.github.io/Lazuli/doxygen/latest/>`_
