Skip to content

Commit 82662bd

Browse files
committed
docs: replace unpublished npm install command
1 parent 86dcc5e commit 82662bd

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,22 @@ The durable system contract lives in
1111

1212
## Install
1313

14+
This package is not published to the npm registry. Install it from a checkout:
15+
1416
```sh
15-
npm install -g @compoundingtech/pty
17+
git clone https://github.com/compoundingtech/pty.git
18+
cd pty
19+
npm ci
20+
npm run build
21+
npm install --global --prefix "$HOME/.local" .
22+
export PATH="$HOME/.local/bin:$PATH"
23+
pty --version
1624
```
1725

26+
The install links to the checkout, so keep the checkout at that path. Put
27+
`$HOME/.local/bin` before other bin directories that can contain a different
28+
command named `pty`.
29+
1830
Or install with Nix — see [nix.md](nix.md).
1931

2032
Requires Node.js. Works on macOS and Linux.

0 commit comments

Comments
 (0)