diff options
| author | Yegor Timoshenko <yegortimoshenko@gmail.com> | 2017-12-22 20:17:00 +0300 |
|---|---|---|
| committer | zimbatm <zimbatm@zimbatm.com> | 2017-12-22 17:17:00 +0000 |
| commit | 3c9f432a7146115b2d0b6200c4c19101c29caaba (patch) | |
| tree | 0e0a9c6ab58f8eda82624a5b7f7238fefb6244ed /README.md | |
| parent | 3f2fbacb216c8905f8ca15d2c24fe95472fb9ab2 (diff) | |
treewide: modules -> profiles, separate dirs, list in README (#29)
Enforce proper naming: all paths are lowercase and hyphen-separated,
if there's a line of models (aspire, macbook-pro, thinkpad) it becomes
a subdirectory. Documentation for profiles is moved to README files in
respective directories.
Add an Org mode table that lists all available profiles and their paths.
Instead of fetching repo locally, use a Nix channel. Making hardware
profiles read-only should improve quality and amount of participation
long-term.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index f697a7b..0000000 --- a/README.md +++ /dev/null @@ -1,24 +0,0 @@ -A collection of NixOS modules covering hardware quirks. - -## Usage -The simplest way to use this repo for now is to clone locally and include by path: -``` nix -{ config, pkgs, ... }: - -{ - 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**. - -## Simple tips and tricks - -### Disable PC speaker -```boot.blacklistedKernelModules = [ "pcspkr" ];``` |