Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@ System dependencies
```
# NixOS
nix-shell --run fish -p cargo systemd udev hidapi pkg-config
direnv shell
# NixOS using flakes
nix develop
# Or build fully using flake, see section below

# Fedora
sudo dnf install systemd-devel hidapi-devel
Expand All @@ -179,6 +181,40 @@ sudo pkg install rust hidapi pkgconf
sudo apt install rustup build-essential libhidapi-dev libsystemd-dev libudev-dev libusb-1.0-0-dev pkg-config
```

### Nix Flake

If you have Nix with flakes enabled, you can build and develop without manually installing dependencies.

Run directly from GitHub
```sh
# Run directly from GitHub
nix run github.com:FrameworkComputer/framework-system -- --versions


Build and run locally after cloning:

```
# Build the CLI tool (release)
nix build .#tool

# Build the CLI tool (debug)
nix build .#tool-debug

# Build the UEFI application (release)
nix build .#uefi

# Run the CLI tool directly
nix run .#tool -- --help

# Run the UEFI app in QEMU
nix run .#qemu

# Enter a development shell with all dependencies
nix develop
```

### Building with Cargo

```sh
# Running linter
cargo clippy
Expand Down
160 changes: 0 additions & 160 deletions devenv.lock

This file was deleted.

18 changes: 0 additions & 18 deletions devenv.nix

This file was deleted.

13 changes: 0 additions & 13 deletions devenv.yaml

This file was deleted.

82 changes: 82 additions & 0 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading