Skip to content

Commit

Permalink
Update README.md (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagokokada authored Oct 9, 2023
1 parent a948cf7 commit b27277d
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ $ nix-alien-ld myapp # Spawns you inside a shell with NIX_LD_LIBRARY_PAT
$ nix-alien-find-libs myapp # Lists all libs needed for the binary
```

## Usage
## Quick start

If your binary is located in `~/myapp`, run:

```console
$ nix --extra-experimental-features "nix-command flakes" run github:thiagokokada/nix-alien -- ~/myapp
```

> :warning: Previous versions of `nix-alien` needed you to setup `nix-index`
> first. This is not needed anymore, so you can remove any trace of `nix-index`
> from your config if you only use it for `nix-alien`.
## Usage

Once `nix-alien` is installed in your system, all you need to do is run:

Expand Down Expand Up @@ -131,6 +135,15 @@ $ nix run "github:thiagokokada/nix-alien#nix-alien-ld" -- ~/myapp
$ nix run "github:thiagokokada/nix-alien#nix-alien-find-libs" -- ~/myapp
```

Or if you don't have Flakes enabled but still wants to run it without
downloading it first:

```console
$ nix --extra-experimental-features "nix-command flakes" run "github:thiagokokada/nix-alien#nix-alien" -- ~/myapp
$ nix --extra-experimental-features "nix-command flakes" run "github:thiagokokada/nix-alien#nix-alien-ld" -- ~/myapp
$ nix --extra-experimental-features "nix-command flakes" run "github:thiagokokada/nix-alien#nix-alien-find-libs" -- ~/myapp
```

## NixOS Installation

You can add the following contents to a `/etc/nixos/nix-alien.nix` file:
Expand Down

0 comments on commit b27277d

Please sign in to comment.