Skip to content

Commit

Permalink
README: update instructions for devshell
Browse files Browse the repository at this point in the history
When executing from inside the devshell, there's no sbomnix in $PATH,
but the entrypoints can be called directly.

Signed-off-by: Florian Klink <[email protected]>
  • Loading branch information
flokli committed Nov 15, 2023
1 parent 6111605 commit 7f6fa45
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,22 @@ $ cd sbomnix
$ nix-shell
```

From the development shell, run `sbomnix` as follows:
Keep in mind this doesn't add the various entrypoint binaries to your `PATH`
directly. They are produced during the setuptools build.

While you're in the devshell, you can run run `sbomnix` via the entrypoint file
directly:

```bash
$ sbomnix --help
$ sbomnix/main.py --help
```

## Usage Examples
The usage examples work for both the built package, as well as inside the devshell.

Keep in mind inside the devshell, calls to `sbomnix` need to be replaced with
`sbomnix/main.py` (and similar for other entrypoints).

In the below examples, we use Nix package `wget` as an example target.
To print `wget` out-path on your local system, try:
```bash
Expand Down

0 comments on commit 7f6fa45

Please sign in to comment.