eeva/nixos-hardware
1
0
Fork 0
mirror of https://github.com/NixOS/nixos-hardware synced 2024-12-23 10:09:44 +01:00
Code Issues Releases Wiki Activity

README: extract CONTRIBUTING, clean up

Browse source
This commit is contained in:
Yegor Timoshenko 2017-12-24 19:34:39 +00:00
parent 38fd4c1541
commit 8abb6374c1
No known key found for this signature in database
GPG key ID: C34BF9DCC9DF8210
2 changed files with 19 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.org Normal file
View file

@ -0,0 +1,6 @@
Profiles should favor usability and stability, so performance hacks should be
activated by an additional NixOS option or conservative and performance configs
can be declared in separate profiles.
Because profiles can only be tested with the appropriate hardware, quality
assurance is up to *you*.

33
README.org
View file

@ -1,13 +1,21 @@
NixOS profiles covering hardware quirks.
Add a new channel:
** Setup
Add and update ~nixos-hardware~ channel:
: $ sudo nix-channel --add https://github.com/NixOS/nixos-hardware/archive/master.tar.gz nixos-hardware
: $ sudo nix-channel --update nixos-hardware
Then add an appropriate profile path to ~imports~ in
~/etc/nixos/configuration.nix~. Currently available profiles:
Then import an appropriate profile path from the table below. For example, to
enable ThinkPad X220 profile, your ~imports~ in ~/etc/nixos/configuration.nix~
should look like:
: imports = [ <nixos-hardware/lenovo/thinkpad/x220> ./hardware-configuration.nix ];
** Profiles
|---------------------------+--------------------------------------------|
| Model | Path |
|---------------------------+--------------------------------------------|
| Acer Aspire 4810T | ~<nixos-hardware/acer/aspire/4810t>~ |
@ -15,6 +23,7 @@ Then add an appropriate profile path to ~imports~ in
| Apple MacBook Pro 10,1 | ~<nixos-hardware/apple/macbook-pro/10-1>~ |
| Apple MacBook Pro 12,1 | ~<nixos-hardware/apple/macbook-pro/12-1>~ |
| Dell XPS 15 9550 | ~<nixos-hardware/dell/xps/15-9550>~ |
| Inverse Path USB armory | ~<nixos-hardware/inversepath/usbarmory>~ |
| Lenovo IdeaPad Z510 | ~<nixos-hardware/lenovo/ideapad/z510>~ |
| Lenovo ThinkPad T410 | ~<nixos-hardware/lenovo/thinkpad/t410>~ |
| Lenovo ThinkPad T440p | ~<nixos-hardware/lenovo/thinkpad/t440p>~ |
@ -26,20 +35,4 @@ Then add an appropriate profile path to ~imports~ in
| Samsung Series 9 NP900X3C | ~<nixos-hardware/samsung/np900x3c>~ |
| Supermicro A1SRi-2758F | ~<nixos-hardware/supermicro/a1sri-2758f>~ |
| Supermicro X10SLL-F | ~<nixos-hardware/supermicro/x10sll-f>~ |
For example, to enable ThinkPad X220 profile, your ~imports~ should look like:
: imports = [ <nixos-hardware/lenovo/thinkpad/x220> ./hardware-configuration.nix ];
Profiles should favor usability and stability, so performance hacks should be
activated by an additional NixOS option or conservative and performance configs
can be declared in separate profiles.
Because profiles can only be tested with the appropriate hardware, quality
assurance is up to *you*.
** Simple tips and tricks
*** Disable PC speaker
: boot.blacklistedKernelModules = [ "pcspkr" ];
|---------------------------+--------------------------------------------|