README.md 1.05 KB
Newer Older
Valentin Reis's avatar
Valentin Reis committed
1 2
### `argonix`

Valentin Reis's avatar
Valentin Reis committed
3 4 5 6 7 8 9
wrapper around various nix tools to override sources and provision
dependencies for argo. supports remote target machines.

#### Install

'stable' (the one tracked by argopkgs/master and used in CI):

Valentin Reis's avatar
Valentin Reis committed
10 11 12
``` {.bash}
nix-env -f argopkgs="https://xgitlab.cels.anl.gov/argo/argopkgs/-/archive/master/argopkgs-master.tar.gz" -iA argonix
```
Valentin Reis's avatar
Valentin Reis committed
13 14 15

bleeding:

Valentin Reis's avatar
Valentin Reis committed
16 17 18
``` {.bash}
nix-env -I argopkgs="https://xgitlab.cels.anl.gov/argo/argopkgs/-/archive/master/argopkgs-master.tar.gz" -f "https://xgitlab.cels.anl.gov/argo/argonix/-/archive/master/argonix-master.tar.gz" -iA argonix
```
Valentin Reis's avatar
Valentin Reis committed
19 20 21 22 23 24 25 26 27 28

#### Usage

``` {.bash}
argonix --help
```

Output:

``` {.txt}
Valentin Reis's avatar
Valentin Reis committed
29
Usage: argonix COMMAND
Valentin Reis's avatar
Valentin Reis committed
30 31

Available options:
Valentin Reis's avatar
Valentin Reis committed
32
  COMMAND                  Type of operation to run.
Valentin Reis's avatar
Valentin Reis committed
33
  -h,--help                Show this help text
Valentin Reis's avatar
Valentin Reis committed
34 35 36 37

Available commands:
  build                    Run an argo-compatible nix-build.
  shell                    Enter an argo-compatable nix-shell
Valentin Reis's avatar
Valentin Reis committed
38 39 40 41
```

### Hacking

Valentin Reis's avatar
Valentin Reis committed
42
-   `nix-shell` provides cabal-build, ghcid, hlint
Valentin Reis's avatar
Valentin Reis committed
43

Valentin Reis's avatar
Valentin Reis committed
44
-   edit `.README.md` in place of README.md, run ./shake.hs to generate.