Skip to content

Commit

Permalink
nix: Add installation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
TornaxO7 committed Jun 12, 2024
1 parent 88f9785 commit dd4fb8e
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,44 @@

## Installation

## Nix package manager
There's flake which you can use to start using it. Just [enable flakes](https://wiki.nixos.org/wiki/Flakes#Enable_flakes_temporarily).
Then you're able to use it with:
```
nix run github:godzie44/BugStalker
```

`bugstalker` also provides a package which you can include to your NixOS config.
For example:

<details>

```nix
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
bugstalker.url = "github:godzie44/BugStalker";
};
outpus = {nixpkgs, bugstalker, ...}: {
nixosConfigurations.your_hostname = nixpkgs.lib.nixosSystem {
modules = [
({...}: {
environment.systemPackages = [
# assuming your system runs on a x86-64 cpu
bugstalker.packages."x86_64-linux".default
];
})
];
};
};
}
```

</details>

### Build yourself

First check if the necessary dependencies
(`pkg-config` and `libunwind-dev`) are installed:

Expand Down

0 comments on commit dd4fb8e

Please sign in to comment.