summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEmery Hemingway <emery@vfemail.net>2016-02-08 12:24:29 +0100
committerEmery Hemingway <emery@vfemail.net>2016-02-08 12:37:46 +0100
commit4bd6934a050e4a047a470985c753b1362feaa290 (patch)
treeca8bbbca5e4790956dc2ae7ab9d7d7d6474dfe2d /README.md
Initial commit
Module for SuperMicro A1SRI-2758F
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8d70cb0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+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
+{ config, pkgs, ... }:
+
+{
+ imports =
+ [ /home/user/nixos-hardware/acme/thunkpad-2000.nix ];
+}
+'''