compounding.tech / pty
This repository has no description
0
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

docs: move the Nix install block from README into nix.md (#76)

Nathan wants Nix docs out of the READMEs into a dedicated nix.md across the
convoy/pty ecosystem; pty is the only core repo with Nix doc content, so this
is a pty-only change.

Move the "Or with Nix:" install block (nix profile install + nix develop) out
of README.md into a new nix.md at the repo root, and leave a one-line pointer
("Or install with Nix — see nix.md.") where the block was. nix.md structures
the Nix install (profile install / nix run) and the dev shell (nix develop +
the clone workflow), and notes flake.nix is the source of truth. Every command
is accurate to the flake — packages.default has meta.mainProgram = "pty" so
`nix run` works, and the dev shell provides nodejs_22/python3/pkg-config.

Doc-only and reversible: flake.nix is untouched.

authored by

Nathan and committed by
GitHub (Jul 13, 2026, 12:09 PM +0200) 349ae490 f055f595

+46 -6
+1 -6
README.md
··· 12 12 npm install -g @myobie/pty 13 13 ``` 14 14 15 - Or with Nix: 16 - 17 - ```sh 18 - nix profile install github:compoundingtech/pty # install the CLI 19 - nix develop github:compoundingtech/pty # dev shell with node, npm, native deps 20 - ``` 15 + Or install with Nix — see [nix.md](nix.md). 21 16 22 17 Requires Node.js. Works on macOS and Linux. 23 18
+45
nix.md
··· 1 + # pty with Nix 2 + 3 + pty ships a [flake](flake.nix) with a package and a development shell. Both need 4 + [Nix](https://nixos.org/download) with flakes enabled. Works on macOS and Linux. 5 + 6 + ## Install the CLI 7 + 8 + Install `pty` into your Nix profile: 9 + 10 + ```sh 11 + nix profile install github:compoundingtech/pty 12 + ``` 13 + 14 + This builds the CLI from the flake's default package and puts `pty` on your 15 + `PATH`. Upgrade later with `nix profile upgrade`, remove with 16 + `nix profile remove`. 17 + 18 + To run it once without installing: 19 + 20 + ```sh 21 + nix run github:compoundingtech/pty 22 + ``` 23 + 24 + ## Development shell 25 + 26 + For hacking on pty itself, drop into the flake's dev shell — it provides the 27 + toolchain needed to build the `node-pty` native addon (Node.js, Python, and 28 + pkg-config): 29 + 30 + ```sh 31 + nix develop github:compoundingtech/pty 32 + ``` 33 + 34 + Or, from a clone of this repo: 35 + 36 + ```sh 37 + git clone https://github.com/compoundingtech/pty 38 + cd pty 39 + nix develop # enters the dev shell with node, python3, pkg-config 40 + npm install 41 + npm run build 42 + ``` 43 + 44 + The flake's `flake.nix` is the source of truth for both the package and the dev 45 + shell — this document only describes how to use them.