update README

This commit is contained in:
Emery Hemingway 2016-02-10 18:38:03 +01:00
parent 9627fe706f
commit 576f0cc4a2

View file

@ -1,9 +1,5 @@
A collection of NixOS modules covering hardware quirks.
Modules should favor usability and stability, so performance hacks
should be activated by an additional a NixOS option or conservative
and performance configs can be declared in seperate modules.
## Usage
The simplest way to use this repo for now is to clone locally and include by path:
``` nix
@ -13,4 +9,11 @@ The simplest way to use this repo for now is to clone locally and include by pat
imports =
[ /home/user/nixos-hardware/acme/thunkpad-2000.nix ];
}
'''
```
Modules should favor usability and stability, so performance hacks
should be activated by an additional a NixOS option or conservative
and performance configs can be declared in seperate modules.
Because modules can only be tested with the appropriate hardware,
quality assurance is up to **you**.