Skip to content

Commit

Permalink
Add install instructions for building without Nix
Browse files Browse the repository at this point in the history
Signed-off-by: Šimon Brandner <[email protected]>
  • Loading branch information
SimonBrandner committed Sep 6, 2024
1 parent 1f06765 commit 78ef9d1
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ about [how Oblichey works](/docs/how_does_it_work.md) before using it.
time of year etc.
- Contributions are welcome!

## Installation
## Installation and setup

### NixOS

Expand Down Expand Up @@ -64,6 +64,10 @@ And now you are good to go!

### Other distributions

#### Building

##### Using the Nix package manager

Install the Nix package manager. It is not to be confused with NixOS. NixOS is
a whole distribution but we only need the package manager which can be
installed on any distribution. It is going to manage dependencies for us. It
Expand All @@ -81,9 +85,30 @@ nix build
```

Once the build process has finished, the resulting binary, library and weights
will be located in `./result/`. You can now add `oblichey-cli` to your `PATH`,
so that the PAM module can use it. It is recommended to move the build output
to a more proper place though.
will be located in `./result/`.

##### Manually (without the Nix package manager)

If you do not want to install Nix and know what you are doing, you can build
manually. For that you are going to need to take a look at the [`package.nix`
file](./nix/package.nix) and install the equivalents of the packages listed in
`nativeBuildInputs` and `buildInputs` for your distribution.

Once that is done you can clone the repo and build using cargo.

```sh
git clone https://github.com/SimonBrandner/oblichey/
cd oblichey
cargo build --release
```

Once the build process has finished, the resulting binary, library and weights
will be located in `./target/release/`.

#### Setup

You can now add `oblichey-cli` to your `PATH`, so that the PAM module can use
it. It is recommended to move the build output to a more proper place though.

Now, it is necessary to create a configuration file at `/etc/oblichey.toml`
with the path to your IR camera. It will usually be something like
Expand Down

0 comments on commit 78ef9d1

Please sign in to comment.