Skip to content

Document the source installation #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
myobie wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the source installation #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,22 @@ The durable system contract lives in

## Install

This package is not published to the npm registry. Install it from a checkout:

```sh
npm install -g @compoundingtech/pty
git clone https://github.com/compoundingtech/pty.git
cd pty
npm ci
npm run build
npm install --global --prefix "$HOME/.local" .
export PATH="$HOME/.local/bin:$PATH"
pty --version
```

The install links to the checkout, so keep the checkout at that path. Put
`$HOME/.local/bin` before other bin directories that can contain a different
command named `pty`.

Or install with Nix — see [nix.md](nix.md).

Requires Node.js. Works on macOS and Linux.
Expand Down
Loading