Skip to content

Commit bab241b

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

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 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,9 +69,14 @@ just the terminal.
6869

6970
## `dev` via Shellcode
7071

71-
Shellcode works _as well_ and is your preference. It has notable caveats with
72-
regard to use in tools like editors. It also requires you to add shellcode to
73-
your `shell.rc` files and thus is more intrusive (depending on your outlook).
72+
Using `dev` via shellcode requires hooks to be installed in your shell. It
73+
is handy in that no tool needs to be installed. It is problematic in that
74+
shell hooks are more invasive and don’t work in other tools like editors.
75+
76+
---
77+
78+
<details>
79+
<summary>Using <code>dev</code> via shellcode…</summary>
7480

7581
A great advantage of the shellcode is not needing to install tools you may never
7682
need again when exploring new open source projects.
@@ -148,6 +154,10 @@ command not found: node
148154
>
149155
> The devenv will only exist for the duration of your shell session.
150156
157+
</details>
158+
159+
---
160+
151161
## How Packages are Determined
152162
153163
- We look at the files you have and figure out the packages you need.

0 commit comments

Comments
 (0)