diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org new file mode 100644 index 0000000..fc6ed8a --- /dev/null +++ b/CONTRIBUTING.org @@ -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*. diff --git a/README.org b/README.org index 1a632ac..f08f032 100644 --- a/README.org +++ b/README.org @@ -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 = [ ./hardware-configuration.nix ]; + +** Profiles + +|---------------------------+--------------------------------------------| | Model | Path | |---------------------------+--------------------------------------------| | Acer Aspire 4810T | ~~ | @@ -15,6 +23,7 @@ Then add an appropriate profile path to ~imports~ in | Apple MacBook Pro 10,1 | ~~ | | Apple MacBook Pro 12,1 | ~~ | | Dell XPS 15 9550 | ~~ | +| Inverse Path USB armory | ~~ | | Lenovo IdeaPad Z510 | ~~ | | Lenovo ThinkPad T410 | ~~ | | Lenovo ThinkPad T440p | ~~ | @@ -26,20 +35,4 @@ Then add an appropriate profile path to ~imports~ in | Samsung Series 9 NP900X3C | ~~ | | Supermicro A1SRi-2758F | ~~ | | Supermicro X10SLL-F | ~~ | - -For example, to enable ThinkPad X220 profile, your ~imports~ should look like: - - : imports = [ ./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" ]; +|---------------------------+--------------------------------------------|