Commit 772f8098 authored by Valentin Reis's avatar Valentin Reis

[doc] Readme update

parent 87081c28
Pipeline #4715 passed with stage
in 6 seconds
......@@ -35,12 +35,12 @@ this repository. They all have default values.
For a more involved example, let's run a test in a custom environment. Here,
we'll run the 'helloworld' test in an environment that uses a local `nrm`
source, the master `libnrm` branch and a specific revision of the `containers`
branch:
branch. We'l'l use the master `argotest` branch for that.
```nix
nix-shell -E '{ argotest ? (builtins.fetchGit {
url = https://xgitlab.cels.anl.gov/argo/argotest.git;
ref="argo-nodeos-config-suid-dir";})
ref="master";})
}:
(import argotest {
nrm-src = /path/to/nrm;
......
......@@ -35,12 +35,13 @@ file in this repository. They all have default values.
For a more involved example, let's run a test in a custom environment.
Here, we'll run the 'helloworld' test in an environment that uses a
local `nrm` source, the master `libnrm` branch and a specific revision
of the `containers` branch:
of the `containers` branch. We'l'l use the master `argotest` branch for
that.
``` {.nix}
nix-shell -E '{ argotest ? (builtins.fetchGit {
url = https://xgitlab.cels.anl.gov/argo/argotest.git;
ref="argo-nodeos-config-suid-dir";})
ref="master";})
}:
(import argotest {
nrm-src = /path/to/nrm;
......@@ -128,8 +129,10 @@ Available commands:
with properly cleaned sockets, logfiles.
application Setup stack and run an arbitrary command in a
container.
helloworld Test 1: Setup stack and check that hello world app
helloworld Test 1: Setup stack and check that a hello world app
sends message back to cmd.
perfwrapper Test 2: Setup stack and check that a hello world app
sends message back to cmd. Uses argo-perf-wrapper.
```
``` {.bash}
......@@ -138,7 +141,8 @@ argotk.hs helloworld --help
``` {.txt}
Usage: argotk.hs helloworld
Test 1: Setup stack and check that hello world app sends message back to cmd.
Test 1: Setup stack and check that a hello world app sends message back to
cmd.
Available options:
-h,--help Show this help text
......@@ -149,12 +153,10 @@ argotk.hs application --help
```
``` {.txt}
Usage: argotk.hs application [-w|--working_directory DIRECTORY] COMMAND
Usage: argotk.hs application COMMAND
Setup stack and run an arbitrary command in a container.
Available options:
-w,--working_directory DIRECTORY
Working directory. Will be used for logging.
COMMAND Application to run inside the container
-h,--help Show this help text
```
......@@ -164,13 +166,11 @@ argotk.hs daemon --help
```
``` {.txt}
Usage: argotk.hs daemon [-w|--working_directory DIRECTORY]
Usage: argotk.hs daemon
Set up and launch the daemon in synchronous mode, with properly cleaned
sockets, logfiles.
Available options:
-w,--working_directory DIRECTORY
Working directory. Will be used for logging.
-h,--help Show this help text
```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment