Skip to content
This repository was archived by the owner on May 1, 2020. It is now read-only.

Commit 7c4c883

Browse files
committed
Update docs
1 parent 55c0096 commit 7c4c883

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ There is also [a more complete example](#full-example) that makes use of all the
3434

3535
Refer to the PureScript [compiler usage](https://github.com/purescript/purescript/wiki/Language-Guide:-Getting-Started#compiler-usage) section of the Github wiki for additional details on the behaviour of each option below.
3636

37+
Options can be passed to the Haskell runtime system for `psc` by passing a `--psc-rts-opts` argument to `gulp`. Any values that follow this flag will be passed through to the runtime. There is no need to include `+RTS`/`-RTS` options as these are inserted automatically. See [the GHC documentation](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/runtime-control.html#rts-opts-cmdline) for information on the available RTS options.
38+
3739
### `purescript.psc(options)`
3840

3941
Invokes the `psc` command. The following options are supported.
@@ -74,6 +76,10 @@ Sets `--output=<string>` the specifies the output directory, `output` by default
7476

7577
Toggles `--no-prefix` that does not include the comment header.
7678

79+
###### `requirePath` (String)
80+
81+
Sets `--require-path=<string>` that specifies the path prefix to use for `require()` calls in the generated JavaScript.
82+
7783
### `purescript.pscBundle(options)`
7884

7985
Invokes the `psc-bundle` command. The following options are supported.
@@ -100,7 +106,7 @@ Sets `--namespace=<string>` that specifies the namespace that PureScript modules
100106

101107
###### `requirePath` (String)
102108

103-
Sets `--require-path=<string>` that specifies the path prefix to use for `require()` calls in the generated JavaScript.
109+
Sets `--require-path=<string>` that specifies the path prefix to use for `require()` calls in the generated JavaScript. This should be set any value used in the `psc` task.
104110

105111
### `purescript.pscDocs(options)`
106112

0 commit comments

Comments
 (0)