Skip to content

Commit

Permalink
README: add getting started section
Browse files Browse the repository at this point in the history
Add links to the youtube tutorial series and getting started section of
the documentation on readthedocs.

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
  • Loading branch information
Emantor authored and Bastian-Krause committed Sep 30, 2024
1 parent f1b2bc3 commit d377f0a
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Labgrid is an embedded board control python library with a focus on testing, dev
and general automation.
It includes a remote control layer to control boards connected to other hosts.

* `Getting started <#Getting-started>`_

* `Purpose and Features <#purpose-and-features>`_

* `Documentation <#documentation>`_
Expand All @@ -24,6 +26,15 @@ It includes a remote control layer to control boards connected to other hosts.

* `Install Development State <#install-development-state>`_

Getting started
---------------
There is a tutorial series on the Pengutronix Youtube channel you can follow to
get started: `Labgrid Tutorial Playlist
<https://www.youtube.com/playlist?list=PLPy6BX4pJosCEq7CIU06bt2WM7lFAy1CF>`_.

The other starting point is in the `documentation
<https://labgrid.readthedocs.io/en/latest/getting_started.html>`__.

Purpose and Features
--------------------
The idea behind labgrid is to create an abstraction of the hardware control
Expand Down

0 comments on commit d377f0a

Please sign in to comment.