add: readme

This commit is contained in:
Adam Stephens 2024-01-22 12:48:47 -05:00
parent df8c1f5256
commit 9320defc4b
No known key found for this signature in database

40
README.md Normal file
View file

@ -0,0 +1,40 @@
# nixos x13s
This repository aims to provide easy, shared, support for Lenovo X13s on Linux.
The support for this machine is constantly improving in mainline kernel and upstream packages. Eventually the goal is that this repository is no longer necessary.
## Add with a flake
```nix
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
nixos-x13s.url = "git+https://codeberg.org/adamcstephens/nixos-x13s";
};
outputs =
{ ... }@inputs:
{
nixosConfigurations.example = inputs.nixpkgs.lib.nixosSystem {
system = "aarch64-linux";
modules = [
inputs.nixos-x13s.nixosModules.default
{
nixos-x13s.enable = true;
# allow unfree firmware
nixpkgs.config.allowUnfree = true;
# define your fileSystems
fileSystems."/".device = "/dev/notreal";
}
];
};
};
}
```
## Add using not a flake
Not documented, but feel free to submit a PR.