From e19173a2da09fb4272e27370b5bbf0f4107a4b9a Mon Sep 17 00:00:00 2001 From: Mika Tammi Date: Thu, 17 Aug 2023 01:24:38 +0300 Subject: [PATCH] README.md: Add section for ghaf-robot Signed-off-by: Mika Tammi --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index b4fd354..edb0bb0 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,21 @@ Jenkinsfiles, Robot framework suites, libraries and requirements for running tests to ghaf-project nixOS with real HW. +## Nix Flake usage + +### Basic test running + +To enter a shell which has the `ghaf-robot` wrapper for running the Robot +Framework, run `nix shell`. + +Alternatively, you can build the package with `nix build` and the wrapper will +appear at `result/bin/ghaf-robot`. + +### Devshell + +To enter a devshell, where you can run `robot` (instead of the wrapper) and all +the Python dependencies are available, run `nix develop`. + ## drcontrol.py For more information, see [drcontrol-README.md](./drcontrol/drcontrol-README.md).