@@ -6,6 +6,33 @@ The tool works on Linux, Windows and the UEFI shell.
66Download it from the latest [ GH Actions] ( https://github.com/FrameworkComputer/framework-system/actions?query=branch%3Amain ) run on the main branch.
77Most features are supported on every "OS". See below for details.
88
9+ ## Installation
10+
11+ ### Linux
12+
13+ - [ NixOS] ( https://github.com/NixOS/nixpkgs/blob/nixos-25.05/pkgs/by-name/fr/framework-tool/package.nix )
14+ - ` nix-shell -p framework-tool `
15+ - [ ArchLinux] ( https://archlinux.org/packages/extra/x86_64/framework-system/ )
16+ - ` pacman -Sy framework-system `
17+ - [ Bazzite] ( https://github.com/ublue-os/bazzite/pull/3026 )
18+ - Others
19+ - Build from source
20+ - Or download [ latest binary] ( https://github.com/FrameworkComputer/framework-system/releases/latest/download/framework_tool )
21+ - ChromeOS
22+ - Build from source
23+
24+ ### Windows
25+
26+ ```
27+ winget install FrameworkComputer.framework_tool
28+ ```
29+
30+ ### FreeBSD
31+
32+ ```
33+ sudo pkg install framework-system
34+ ```
35+
936## Features
1037
1138To check which features are supported on which OS and platform,
@@ -153,6 +180,9 @@ ls -l framework_uefi/build/x86_64-unknown-uefi/boot.efi
153180# NixOS
154181nix-shell --run fish -p cargo systemd udev hidapi pkg-config
155182direnv shell
183+
184+ # FreeBSD
185+ sudo pkg install hidapi
156186```
157187
158188## Install local package
@@ -226,15 +256,6 @@ Many actions require root. First build with cargo and then run the binary with s
226256cargo build && sudo ./target/debug/framework_tool
227257```
228258
229- ###### Running on Windows
230-
231- On newly released systems since 2025 the Framework driver installer includes the EC driver.
232- This includes Framework 12, Framework 13 AMD Ryzen AI 300, Framework Desktop.
233-
234- Previous platforms will be enabled next.
235-
236- Installing: ` winget install FrameworkComputer.framework_tool `
237-
238259##### Running on ChromeOS
239260
240261The application can run on ChromeOS but most commands rely on custom host
@@ -329,15 +350,3 @@ Keyboard backlight: 0%
329350[DEBUG] send_command(command=0x22, ver=0, data_len=0)
330351Keyboard backlight: 0%
331352```
332-
333- ## FreeBSD
334-
335- ```
336- sudo pkg install hidapi
337-
338- # Build the library and tool
339- cargo build
340-
341- # Running the tool
342- cargo run
343- ```
0 commit comments