Skip to content

Commit ca4e999

Browse files
authored
Update the Devbox setup instructions (#308)
Added relevant information to the `Getting Started - Devbox Variant` section of the `README.md` file.
1 parent e66de92 commit ca4e999

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,21 @@ make image
5454
make
5555
```
5656

57-
### Getting strated - devbox variant
57+
### Getting Started - Devbox Variant
5858

5959
To simplify the usage of `pytm` host dependencies can be completely isolated
60-
using [`devbox`](https://github.com/jetify-com/devbox). This is usually a
60+
using [`Devbox`](https://github.com/jetify-com/devbox). This is usually a
6161
lower overhead and more convenient alternative to the OCI container approach.
6262

63-
- Install devbox on Linux/MacOS: `curl -fsSL https://get.jetify.com/devbox | bash`
64-
- Install devbox on [Windows/WSL2](https://www.jetify.com/docs/devbox/installing_devbox/?install-method=wsl)
65-
- update to latest version: `devbox version update`
66-
- `devbox shell`
67-
- `which python` -> `.devbox/nix/profile/default/bin/python`
68-
- `./tm.py --dfd | dot -Tpng -o sample.png` -> `sample.png`
69-
- `exit`
63+
- Install Devbox on Linux/MacOS: `curl -fsSL https://get.jetify.com/devbox | bash`
64+
- Install Devbox on [Windows/WSL](https://www.jetify.com/docs/devbox/installing-devbox/index#installing-wsl2)
65+
- Update to latest version of devbox: `devbox version update`
66+
- Set your GitHub access token in the `~/.config/nix/nix.conf` file file: `access-tokens = github.com=YOUR_TOKEN_HERE`
67+
- Create a new, isolated shell environment that includes all the tools and packages specified in the project's `devbox.json` file: `devbox shell`
68+
- Display the full path to the Python executable that will be used when you simply type `python` in your terminal by using the which python command. The output should be the following path: `.devbox/nix/profile/default/bin/python`
69+
- Test by running the following command, which should generate a DFD as a PNG file called `sample.png`: `./tm.py --dfd | dot -Tpng -o sample.png`
70+
- Exit the Devbox shell environment: `exit`
71+
7072

7173
## Usage
7274

@@ -130,7 +132,7 @@ Element class attributes:
130132
The *colormap* argument, used together with *dfd*, outputs a color-coded DFD where the elements are painted red, yellow or green depending on their risk level (as identified by running the rules).
131133

132134

133-
## Usage - devbox variant
135+
## Usage - Devbox Variant
134136

135137
- `devbox shell`
136138
- `pytm` usage as usual

0 commit comments

Comments
 (0)