You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-3Lines changed: 38 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ A *user-friendly* distribution of the [Raku programming language](https://raku.o
20
20
## Docker Image
21
21
22
22
* Please refer to [Rakudo-Star on Docker Hub](https://hub.docker.com/_/rakudo-star) for an image.
23
-
* Find the related Docker files on the ["Raku Docker" GitHub repository](https://github.com/Raku/docker)
23
+
* Find the related Docker files on the ["Raku Docker" GitHub repository](https://github.com/Raku/docker)
24
24
25
25
## What's in this GIT repo
26
26
@@ -32,6 +32,41 @@ Both tools compile Rakudo and then add some selected modules!
32
32
33
33
### 1. _RSTAR_ tool
34
34
35
+
#### Usage
36
+
37
+
```
38
+
rstar install [options] [core] [modules]
39
+
```
40
+
41
+
**Options:**
42
+
43
+
| Option | Description |
44
+
|--------|-------------|
45
+
|`-b <backend>`| Set the compiler backend (default: `moar`) |
46
+
|`-p <prefix>`| Set the installation prefix |
47
+
|`-T`| Skip module tests (`--/test`) during installation |
48
+
49
+
**Skipping module tests:**
50
+
51
+
By default, `zef` runs all tests when installing bundled modules. Pass `-T` to
52
+
disable this, which can significantly speed up installation:
53
+
54
+
```sh
55
+
rstar install -T modules
56
+
```
57
+
58
+
You can also set the environment variable `RSTAR_NO_TEST` to any non-empty
59
+
value to achieve the same effect without modifying the command:
60
+
61
+
```sh
62
+
RSTAR_NO_TEST=1 rstar install modules
63
+
```
64
+
65
+
> Note: When a module fails and is retried with `--force-test`, tests are
66
+
> always run regardless of this option.
67
+
68
+
---
69
+
35
70
*`bash` based tool, should work on any **Linux OS** (_should also build Rakudo-Star on macOS_!?).
36
71
- The `rstar` (bash) tool downloads all requirements, like MoarVM, NQP, Rakudo and some Rakudo modules.
37
72
- It then compiles everything into a local Rakudo installation and add's the modules via `zef`.
@@ -47,7 +82,7 @@ Furthermore, all code should be linted against [`shellcheck`](https://www.shellc
47
82
48
83
* A [Powershell script](https://github.com/rakudo/star/blob/master/tools/build/binary-release/Windows/build-with-choco.ps1), which internally uses `chocolatey` to create a **Windows MSI** package.
49
84
- The created MSI package can be used to install Rakudo-Star (Rakudo with some additional modules) on any Windows device.
50
-
**More information to be added* in the [wiki](https://github.com/rakudo/star/wiki)
85
+
**More information to be added* in the [wiki](https://github.com/rakudo/star/wiki)
51
86
52
87
### 3. Community Modules
53
88
@@ -65,7 +100,7 @@ the module, the second the protocol to use, with the third column being the
65
100
URL to fetch it from. Columns following the third have different meaning
66
101
depending on the protocol.
67
102
68
-
*Currently all modules are expected to be available via `git` (GitHub) and having `git tags`, similar to the `version` given in the modules `META6.json`*
103
+
*Currently all modules are expected to be available via `git` (GitHub) and having `git tags`, similar to the `version` given in the modules `META6.json`*
0 commit comments