.. rtems-build-tool documentation master file, created by
   sphinx-quickstart on Mon Sep 11 20:47:35 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: logo_hzb_big.png
      :align: right
      :target: http://www.helmholtz-berlin.de

==========================================
Welcome to rtems-build-tool documentation!
==========================================

.. toctree::
   :maxdepth: 1

   introduction
   configuration
   scripts
   binaries

.. _RTEMS: https://www.rtems.org

This project generates a boot image with the the RTEMS_ kernel for RTEMS_ versions
4.9, 4.10, 4.11 and 5. 

In it's default configuration it creates images for the 
`mvme2100 CPU <https://www.systerra.de/MOTMVME2100.html#HinweisBestaetigen>`_
but you can create images for all platforms that are supported in RTEMS_.

Here at the `Helmholtz-Zentrum Berlin <https://www.helmholtz-berlin.de>`_
we use these images to run `EPICS <https://epics-controls.org/>`_ applications.

Note that you must have the RTEMS_ cross compiler tools installed. You can
use 
`rtems-from-scratch <https://rtems-from-scratch.sourceforge.io>`_
to install these.

How to download
===============

Currently you can only download the project with mercurial with this command::

  hg clone http://hg.code.sf.net/p/rtems-build-tool/code rtems-build-tool

rtems-build-tool at sourceforge
=================================

You find the sourceforge summary page for rtems-build-tool at
`rtems-build-tool <https://sourceforge.net/projects/rtems-build-tool>`_.

There you also find the link to download the software repository.

:Author:
    Goetz Pfeiffer (Goetz.Pfeiffer@helmholtz-berlin.de, goetzpf@googlemail.com)




.. Indices and tables
.. ==================
.. 
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`