summaryrefslogtreecommitdiff
path: root/scripts/README.md
blob: 37388e74b55706002183371a4fdd92cb4bdfa5cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
## run the scripts

> **Note**  
> the following table must be read as follows:
> - an `x` means *it works*
> - a `?` means *no data available*
>
> `.nu` scripts must be run as `nu .../foo.nu`  
> `.sh` scripts must be run as `./.../foo.sh`  
> `.ps1` scripts must be run as `powershell .../foo.ps1`
>
> let's say a script is called `foo`
> - an `x` in the *`./scripts`* column means *`foo` can be run from `./scripts`*
> - an `x` in the *root* column means *`foo` can be run from the root of `nushell`*
> - an `x` in the *anywhere* column means *`foo` can be run from anywhere!*

| script                  | `./scripts/` | root | anywhere |
| ----------------------- | ------------ | ---- | -------- |
| `build-all-maclin.sh`   | x            | x    | x        |
| `build-all-windows.cmd` | ?            | x    | ?        |
| `build-all.nu`          | x            | x    | x        |
| `coverage-local.nu`     | x            | x    | x        |
| `coverage-local.sh`     | x            | x    | x        |
| `install-all.ps1`       | ?            | x    | ?        |
| `install-all.sh`        | x            | x    | x        |
| `uninstall-all.sh`      | x            | x    | x        |