Skip to content

Commit

Permalink
readme: update sections
Browse files Browse the repository at this point in the history
This adds actual content to the readme file.

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
  • Loading branch information
Emantor authored and jluebbe committed Mar 13, 2017
1 parent 94572da commit 8d3ac66
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,63 @@ Welcome to labgrid

Purpose
-------
Labgrid is a embedded board control library which also supports remote exports
and management of embedded boards.

It currently supports:

- pytest-plugin to write tests for embedded systems connecting over SSH or Serial
- remote client-exporter-coordinator infrastructure to make boards available
from different computers on a network
- Power/Reset management via plugins for power switches or onewire PIOs
- Upload of images via imxusbloader/mxusbloader or fastboot
- Functions to control external services such as emulated USB-Sticks and the
`Hawkbit <https://github.com/eclipse/hawkbit>`_ deployment service

Documentation
-------------
`Read the docs <http://labgrid.readthedocs.io/en/latest/>`_

Contributing
------------
`Development Docs <http://labgrid.readthedocs.io/en/latest/development.html>`_


Quickstart
----------

Clone the git repository:

.. code-block:: bash
git clone https://github.com/labgrid-project/labgrid
Create and activate a virtualenv for labgrid:

.. code-block:: bash
virtualenv -p python3 venv
source venv/bin/activate
Install required dependencies:

.. code-block:: bash
sudo apt install libow-dev
Install labgrid into the virtualenv:

.. code-block:: bash
python setup.py install
Tests can now run via:

.. code-block:: bash
python -m pytest --env-config=<config>
.. |license| image:: https://img.shields.io/badge/license-LGPLv2.1-blue.svg
:alt: LGPLv2.1
Expand Down

0 comments on commit 8d3ac66

Please sign in to comment.