GolemOS: Custom Linux distribution for embedded systems
=======================================================

.. meta::
   :description lang=en: GolemOS is custom linux distribution designed for embedded systems.

Custom Linux distribution is clue for good embedded system project. GolemOS is
Linux distribution build with help of `YoctoProject`_ end `OpenEmbedded`_. Main
goal for the team is to create minimal but fully functional system with ability
to be compiled for various amount of small computer boards.

.. _YoctoProject: https://www.yoctoproject.org/
.. _OpenEmbedded: https://www.openembedded.org/

Quick start
-----------

Every project needs an introduction. This section tells you some informations
about YoctoProject and why this project was invented. Also you can find here
overview about what to expect from GolemOS.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Introduction

   introduction/intentions

Documentation
-------------

Documentation provide all necessary information about GolemOS for future
developers. Here you can find all steps how to build fully functional GolemOS
system as well as dependencies. However the most important thing in this
section is recipes overviews. They tell what each recipe does and why it was
done in this way.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Documenation

   documentation/build
   documentation/dependencies
   documentation/patches
   documentation/recipes

Step by step guide
------------------

This section will be really helpful for person who wants to recreate GolemOS in
future. Here you will find all steps which were made to create custom Linux
distribution. From simple things like creating a custom meta layer, to a
collection of recipes to ensure the correct operation of a wireless network or
hotspot.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Step-by-step guides (Basics)

   step-by-step-guide-basic/layer
   step-by-step-guide-basic/distribution
   step-by-step-guide-basic/template
   step-by-step-guide-basic/images
   step-by-step-guide-basic/packages

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Step-by-step guides (Extended)

   step-by-step-guide-extended/wireless-network
   step-by-step-guide-extended/hotspot
   step-by-step-guide-extended/flask
   step-by-step-guide-extended/python-gunicorn-server
   step-by-step-guide-extended/web-server
   step-by-step-guide-extended/python-packages