summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYegor Timoshenko <yegortimoshenko@riseup.net>2018-08-24 13:58:48 +0300
committerYegor Timoshenko <yegortimoshenko@riseup.net>2018-08-24 14:16:24 +0300
commit80ad9d8b661c2ae9e8b72e226a82d7ecb6c40c08 (patch)
treea862f71ef944e1f2711989bc580ffb743d95d884
parent218ef7df3c71e3b3c6840a28e2aae8a261156e0d (diff)
Add to README.md, redo the table in Markdown
-rw-r--r--README.md61
-rw-r--r--README.org47
2 files changed, 61 insertions, 47 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..251ff0b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+NixOS profiles covering hardware quirks.
+
+## 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 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>` |
+| Airis N990 | `<nixos-hardware/airis/n990>` |
+| Apple MacBook Air 4,X | `<nixos-hardware/apple/macbook-air/4>` |
+| Apple MacBook Air 6,X | `<nixos-hardware/apple/macbook-air/6>` |
+| [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>` |
+| Lenovo ThinkPad T460s | `<nixos-hardware/lenovo/thinkpad/t460s>` |
+| Lenovo ThinkPad X140e | `<nixos-hardware/lenovo/thinkpad/x140e>` |
+| Lenovo ThinkPad X220 | `<nixos-hardware/lenovo/thinkpad/x220>` |
+| Lenovo ThinkPad X230 | `<nixos-hardware/lenovo/thinkpad/x230>` |
+| Lenovo ThinkPad X250 | `<nixos-hardware/lenovo/thinkpad/x250>` |
+| Lenovo ThinkPad X270 | `<nixos-hardware/lenovo/thinkpad/x270>` |
+| [Microsoft Surface Pro 3][] | `<nixos-hardware/microsoft/surface-pro/3>` |
+| PC Engines APU | `<nixos-hardware/pcengines/apu>` |
+| [Raspberry Pi 2][] | `<nixos-hardware/raspberry-pi/2>` |
+| [Samsung Series 9 NP900X3C][] | `<nixos-hardware/samsung/np900x3c>` |
+| [Purism Librem 13v3][] | `<nixos-hardware/purism/librem/13v3>` |
+| Supermicro A1SRi-2758F | `<nixos-hardware/supermicro/a1sri-2758f>` |
+| Supermicro X10SLL-F | `<nixos-hardware/supermicro/x10sll-f>` |
+| [Toshiba Chromebook 2 `swanky`][] | `<nixos-hardware/toshiba/swanky>` |
+
+[Acer Aspire 4810T]: acer/aspire/4810t
+[Apple MacBook Pro 10,1]: apple/macbook-pro/10-1
+[Dell XPS 15 9550]: dell/xps/15-9550
+[Inverse Path USB armory]: inversepath/usbarmory
+[Microsoft Surface Pro 3]: microsoft/surface-pro/3
+[Raspberry Pi 2]: raspberry-pi/2
+[Samsung Series 9 NP900X3C]: samsung/np900x3c
+[Purism Librem 13v3]: purism/librem/13v3
+[Toshiba Chromebook 2 `swanky`]: toshiba/swanky
diff --git a/README.org b/README.org
deleted file mode 100644
index 1ed22ee..0000000
--- a/README.org
+++ /dev/null
@@ -1,47 +0,0 @@
-NixOS profiles covering hardware quirks.
-
-** 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 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 |
-|-----------------------------+-----------------------------------------------|
-| [[file:acer/aspire/4810t][Acer Aspire 4810T]] | ~<nixos-hardware/acer/aspire/4810t>~ |
-| Airis N990 | ~<nixos-hardware/airis/n990>~ |
-| Apple MacBook Air 4,X | ~<nixos-hardware/apple/macbook-air/4>~ |
-| Apple MacBook Air 6,X | ~<nixos-hardware/apple/macbook-air/6>~ |
-| [[file:apple/macbook-pro/10-1][Apple MacBook Pro 10,1]] | ~<nixos-hardware/apple/macbook-pro/10-1>~ |
-| [[file:apple/macbook-pro/11-5][Apple MacBook Pro 11,5]] | ~<nixos-hardware/apple/macbook-pro/11-5>~ |
-| Apple MacBook Pro 12,1 | ~<nixos-hardware/apple/macbook-pro/12-1>~ |
-| [[file:dell/xps/15-9550][Dell XPS 15 9550]] | ~<nixos-hardware/dell/xps/15-9550>~ |
-| [[file:inversepath/usbarmory][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>~ |
-| Lenovo ThinkPad T460s | ~<nixos-hardware/lenovo/thinkpad/t460s>~ |
-| Lenovo ThinkPad X140e | ~<nixos-hardware/lenovo/thinkpad/x140e>~ |
-| Lenovo ThinkPad X220 | ~<nixos-hardware/lenovo/thinkpad/x220>~ |
-| Lenovo ThinkPad X230 | ~<nixos-hardware/lenovo/thinkpad/x230>~ |
-| Lenovo ThinkPad X250 | ~<nixos-hardware/lenovo/thinkpad/x250>~ |
-| Lenovo ThinkPad X270 | ~<nixos-hardware/lenovo/thinkpad/x270>~ |
-| [[file:lenovo/thinkpad/x1/6th-gen][Lenovo ThinkPad X1 6th gen.]] | ~<nixos-hardware/lenovo/thinkpad/x1/6th-gen>~ |
-| [[file:microsoft/surface-pro/3][Microsoft Surface Pro 3]] | ~<nixos-hardware/microsoft/surface-pro/3>~ |
-| PC Engines APU | ~<nixos-hardware/pcengines/apu>~ |
-| [[file:raspberry-pi/2][Raspberry Pi 2]] | ~<nixos-hardware/raspberry-pi/2>~ |
-| [[file:samsung/np900x3c][Samsung Series 9 NP900X3C]] | ~<nixos-hardware/samsung/np900x3c>~ |
-| [[file:purism/librem/13v3][Purism Librem 13v3]] | ~<nixos-hardware/purism/librem/13v3>~ |
-| Supermicro A1SRi-2758F | ~<nixos-hardware/supermicro/a1sri-2758f>~ |
-| Supermicro X10SLL-F | ~<nixos-hardware/supermicro/x10sll-f>~ |
-|-----------------------------+-----------------------------------------------|