Skip to content
Merged
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
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can find lots of examples in [EXAMPLES.md](./EXAMPLES.md).

### Linux

- NixOS/nixpkgs [![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/framework-tool.svg)](https://repology.org/project/framework-tool/versions)
- [NixOS/nixpkgs](https://search.nixos.org/packages?channel=unstable&query=framework_tool) [![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/framework-tool.svg)](https://repology.org/project/framework-tool/versions)
- `nix-shell -p framework-tool`
- [ArchLinux](https://archlinux.org/packages/extra/x86_64/framework-system/) [![Arch Linux package](https://repology.org/badge/version-for-repo/arch/framework-system.svg)](https://repology.org/project/framework-system/versions)
- `pacman -S framework-system`
Expand Down Expand Up @@ -41,15 +41,15 @@ You can find lots of examples in [EXAMPLES.md](./EXAMPLES.md).
- [![Manjaro Testing package](https://repology.org/badge/version-for-repo/manjaro_testing/framework-system.svg)](https://repology.org/project/framework-system/versions)
- [![Manjaro Unstable package](https://repology.org/badge/version-for-repo/manjaro_unstable/framework-system.svg)](https://repology.org/project/framework-system/versions)
- `pacman -S framework-system`
- [Cargo](https://crates.io/crates/framework_tool) (Any distro)
- `cargo install --locked framework_tool`
- Others
- Build from source
- Or download [latest binary](https://github.com/FrameworkComputer/framework-system/releases/latest/download/framework_tool)
- ChromeOS
- Build from source
- Homebrew
- Add [this homebrew tap](https://github.com/ublue-os/homebrew-tap), then `brew install --cask framework-tool`
- Cargo (Any distro)
- `cargo install --locked framework_tool`

### Windows

Expand All @@ -65,6 +65,23 @@ winget install framework_tool --source winget
sudo pkg install framework-system
```

### Library

This project includes both a tool and a library, that you can use to build custom software.

The commandline does not guarantee a stable interface, it is intended for
manual usage, for programmatic usage, please use [`framework_lib`](https://crates.io/crates/framework_lib).

The library is still in active development and does not guarantee stable
interfaces. If you, as a user of the library have suggestions for improvements
or requests for features, feel free to create an issue.
To add it to your project add it to your `Cargo.toml`:

```toml
[dependencies]
framework_lib = "0.6.4"
```

## Features

To check which features are supported on which OS and platform,
Expand Down Expand Up @@ -94,6 +111,7 @@ On UEFI and FreeBSD raw port I/O is used - on Linux this can also be used as a f
| AMD Ryzen 7040 | Yes | [6.10](https://github.com/torvalds/linux/commit/c8f460d991df93d87de01a96b783cad5a2da9616) | BIOS 3.16+ |
| Intel Core Ultra S1 | Yes | [6.12](https://github.com/torvalds/linux/commit/62be134abf4250474a7a694837064bc783d2b291) | BIOS 3.06+ |
| AMD Ryzen AI 300 | Yes | [6.12](https://github.com/torvalds/linux/commit/62be134abf4250474a7a694837064bc783d2b291) | Yes |
| Intel Core Ultra S3 | Yes | [6.12](https://github.com/torvalds/linux/commit/62be134abf4250474a7a694837064bc783d2b291) | Yes |
| Framework Laptop 16 | | | |
| AMD Ryzen 7040 | Yes | [6.10](https://github.com/torvalds/linux/commit/c8f460d991df93d87de01a96b783cad5a2da9616) | BIOS 3.06+ |
| AMD Ryzen AI 300 | Yes | [6.10](https://github.com/torvalds/linux/commit/c8f460d991df93d87de01a96b783cad5a2da9616) | Yes |
Expand Down
Loading