Skip to content

Commit d9a7019

Browse files
committed
dev aware pkgs clarification
1 parent db2b47b commit d9a7019

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,16 @@ dev, across your team and in production.
1212
1313
## Getting Started
1414

15-
Since `dev` v1.8.0 we integrate with `pkgm` (^0.11) and this is the
16-
recommended way to use `dev`.
15+
Since `dev` v1.8.0 we integrate with `pkgm` (^0.11) and this is the recommended
16+
way to use `dev`.
1717

1818
> [!IMPORTANT]
1919
>
20-
> `dev` must be installed to `/usr/local/bin/dev` for this route to work:
20+
> Both `dev` and the packages you want to be `dev`-aware must be installed to
21+
> `/usr/local/` for this to work. (`dev` (but only `dev`) can be a `pkgm shim`).
2122
>
2223
> ```sh
23-
> sudo pkgm install dev # use of `shim` is also fine
24+
> sudo pkgm install dev node@22
2425
> ```
2526
2627
```sh
@@ -68,7 +69,13 @@ just the terminal.
6869

6970
## `dev` via Shellcode
7071

71-
Shellcode works _as well_ and is your preference. It has notable caveats with
72+
Shellcode is how `dev` used to work. We still support it. It has the advantage
73+
that none of your tool need be installed — so use is at your preference.
74+
75+
<details>
76+
<summary>Shellcode usage…</summary>
77+
78+
It has notable caveats with
7279
regard to use in tools like editors. It also requires you to add shellcode to
7380
your `shell.rc` files and thus is more intrusive (depending on your outlook).
7481

@@ -106,6 +113,8 @@ more shells.
106113
> If you like, preview the shellcode: `pkgx dev --shellcode`. This command only
107114
> outputs shellcode, it doesn’t modify any files or do anything else either.
108115
116+
</details>
117+
109118
### Usage
110119
111120
```sh

0 commit comments

Comments
 (0)