eeva/nixos-hardware
1
0
Fork 0
mirror of https://github.com/NixOS/nixos-hardware synced 2024-11-15 23:49:41 +01:00
Code Issues Releases Wiki Activity
nixos-hardware/README.md

181 lines
9.9 KiB
Markdown
Raw Normal View History

README.md: update description of the project
2020-06-21 09:49:23 +02:00
NixOS profiles to optimize settings for different hardware.
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
## Setup
README.md: document fetchgit fixes #65
2020-07-28 10:53:58 +02:00
### Using channels
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
Add and update `nixos-hardware` channel:
```
$ sudo nix-channel --add https://github.com/NixOS/nixos-hardware/archive/master.tar.gz nixos-hardware
README: fix nix-channel --update command Following the current instructions yields these errors for some reason: ``` $ sudo nixos-rebuild switch warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos' was not found in the Nix search path (add it using $NIX_PATH or -I), at (string):1:13 building Nix... warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos' was not found in the Nix search path (add it using $NIX_PATH or -I) warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I) warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos/modules/installer/tools/nix-fallback-paths.nix' was not found in the Nix search path (add it using $NIX_PATH or -I) /tmp/nixos-rebuild.vs4JVw/nix warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I) building the system configuration... warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos' was not found in the Nix search path (add it using $NIX_PATH or -I) ```
2020-04-24 10:36:40 +02:00
$ sudo nix-channel --update
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
```
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
];
```
README.md: document fetchgit fixes #65
2020-07-28 10:53:58 +02:00
New updates to the expressions here will be fetched when you update the channel.
## Using nix flakes support
add flake support
2020-06-24 07:06:51 +02:00
There is also experimental flake support. In your `/etc/nixos/flake.nix` add the following:
```nix
{
description = "NixOS configuration with flakes";
inputs.nixos-hardware.url = github:NixOS/nixos-hardware/master;
outputs = { self, nixpkgs, nixos-hardware }: {
# replace <your-hostname> with your actual hostname
nixosConfigurations.<your-hostname> = nixpkgs.lib.nixosSystem {
# ...
modules = [
# ...
Fix link to flake file in README flake example
2021-02-13 20:59:31 +01:00
# add your model from this list: https://github.com/NixOS/nixos-hardware/blob/master/flake.nix
add flake support
2020-06-24 07:06:51 +02:00
nixos-hardware.nixosModules.dell-xps-13-9380
];
};
};
}
```
README.md: document fetchgit fixes #65
2020-07-28 10:53:58 +02:00
Fix fetchGit instructions
2020-10-13 13:55:46 +02:00
### Using fetchGit
README.md: document fetchgit fixes #65
2020-07-28 10:53:58 +02:00
You can fetch the git repository directly:
```nix
Add Lenovo X13 Yoga Gen 1
2021-02-06 18:03:00 +01:00
imports = [
Fix fetchGit instructions
2020-10-13 13:55:46 +02:00
"${builtins.fetchGit { url = "https://github.com/NixOS/nixos-hardware.git"; }}/lenovo/thinkpad/x220"
README.md: document fetchgit fixes #65
2020-07-28 10:53:58 +02:00
];
```
Add Lenovo X13 Yoga Gen 1
2021-02-06 18:03:00 +01:00
Unlike the channel, this will update the git repository on a rebuild. However,
README.md: document fetchgit fixes #65
2020-07-28 10:53:58 +02:00
you can easily pin to a particular revision if you desire more stability.
README: list is complete now
2020-06-21 10:14:32 +02:00
## List of Profiles
Update README.md At first (till third glance) I thought only the listed profiles are supported
2019-09-03 08:47:25 +02:00
See code for all available configurations.
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| Model | Path |
| --------------------------------- | -------------------------------------------------- |
| [Acer Aspire 4810T][] | `<nixos-hardware/acer/aspire/4810t>` |
| Airis N990 | `<nixos-hardware/airis/n990>` |
apple: Add support for MacBook Air 3,X (#91)
2019-11-12 11:36:10 +01:00
| Apple MacBook Air 3,X | `<nixos-hardware/apple/macbook-air/3>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| 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>` |
Add Asus TUF FX504GD
2020-05-20 16:35:48 +02:00
| Asus TUF FX504GD | `<nixos-hardware/asus/fx504gd>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| BeagleBoard PocketBeagle | `<nixos-hardware/beagleboard/pocketbeagle>` |
dell/g3/3779: init Add support for the Dell G3 3779.
2020-12-01 15:19:15 +01:00
| [Dell G3 3779][] | `<nixos-hardware/dell/g3/3779>` |
New dell/latitude/3480 The touchpad is painful to use unless the "psmouse" kernel module is disabled.
2020-05-04 21:49:42 +02:00
| Dell Latitude 3480 | `<nixos-hardware/dell/latitude/3480>` |
add dell precision 5530
2020-08-29 11:36:27 +02:00
| Dell Precision 5530 | `<nixos-hardware/dell/precision/5530>` |
Merge branch 'master' into add-e7240
2019-10-09 16:12:00 +02:00
| [Dell XPS E7240][] | `<nixos-hardware/dell/e7240>` |
Add Dell XPS-7390 Profile (#128)
2019-10-30 20:15:22 +01:00
| [Dell XPS 13 7390][] | `<nixos-hardware/dell/xps/13-7390>` |
Add entry for Dell XPS 13 9310 to README
2020-11-15 20:32:45 +01:00
| [Dell XPS 13 9310][] | `<nixos-hardware/dell/xps/13-9310>` |
add xps 13 (9343)
2020-01-09 05:49:26 +01:00
| [Dell XPS 13 9343][] | `<nixos-hardware/dell/xps/13-9343>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| [Dell XPS 13 9360][] | `<nixos-hardware/dell/xps/13-9360>` |
| [Dell XPS 13 9370][] | `<nixos-hardware/dell/xps/13-9370>` |
| [Dell XPS 13 9380][] | `<nixos-hardware/dell/xps/13-9380>` |
README.md: link to dell xps 15-7590
2020-02-04 12:53:51 +01:00
| [Dell XPS 15 7590][] | `<nixos-hardware/dell/xps/15-7590>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| [Dell XPS 15 9550][] | `<nixos-hardware/dell/xps/15-9550>` |
Mention Dell 9550 NVidia in Read Me and flake.nix
2021-02-09 00:25:17 +01:00
| [Dell XPS 15 9550, nvidia][] | `<nixos-hardware/dell/xps/15-9550/nvidia>` |
add xps 9560 root readme to be able to easily find
2020-02-05 11:47:52 +01:00
| [Dell XPS 15 9560][] | `<nixos-hardware/dell/xps/15-9560>` |
| [Dell XPS 15 9560, intel only][] | `<nixos-hardware/dell/xps/15-9560/intel>` |
| [Dell XPS 15 9560, nvidia only][] | `<nixos-hardware/dell/xps/15-9560/nvidia>` |
Added dell xps 15-9500, with nvidia gpu.
2020-07-22 23:16:27 +02:00
| [Dell XPS 15 9500][] | `<nixos-hardware/dell/xps/15-9500>` |
| [Dell XPS 15 9500, nvidia][] | `<nixos-hardware/dell/xps/15-9500/nvidia>` |
google/pixelbook: init
2020-05-07 16:12:35 +02:00
| [Google Pixelbook][] | `<nixos-hardware/google/pixelbook>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| [Inverse Path USB armory][] | `<nixos-hardware/inversepath/usbarmory>` |
| Lenovo IdeaPad Z510 | `<nixos-hardware/lenovo/ideapad/z510>` |
lenovo/thinkpad/t14: added desc to README.md and flake.nix
2020-11-05 10:38:40 +01:00
| Lenovo ThinkPad E470 | `<nixos-hardware/lenovo/thinkpad/e470>` |
Added entry Thnikpad E495 to README
2020-02-12 10:56:49 +01:00
| Lenovo ThinkPad E495 | `<nixos-hardware/lenovo/thinkpad/e495>` |
Update README.md
2020-01-07 16:04:52 +01:00
| Lenovo ThinkPad L13 | `<nixos-hardware/lenovo/thinkpad/l13>` |
lenovo/thinkpad/l14: init Add support for the Lenovo Thinkpad L14 Gen 1 Intel and AMD variants.
2020-10-07 21:13:52 +02:00
| Lenovo ThinkPad L14 (Intel) | `<nixos-hardware/lenovo/thinkpad/l14/intel> |
| Lenovo ThinkPad L14 (AMD) | `<nixos-hardware/lenovo/thinkpad/l14/amd> |
Initial p53 hardware configuration (#125)
2019-10-16 20:25:20 +02:00
| Lenovo ThinkPad P53 | `<nixos-hardware/lenovo/thinkpad/p53>` |
lenovo/thinkpad/t14: added desc to README.md and flake.nix
2020-11-05 10:38:40 +01:00
| Lenovo ThinkPad T14 | `<nixos-hardware/lenovo/thinkpad/t14>` |
| Lenovo ThinkPad T14 AMD Gen 1 | `<nixos-hardware/lenovo/thinkpad/t14/amd/gen1>` |
t14s: init Copied from t495.
2020-10-25 19:24:43 +01:00
| Lenovo ThinkPad T14s | `<nixos-hardware/lenovo/thinkpad/t14s>` |
t14s: add AMD Gen1 model t14s: fix minimum required kernel version
2020-10-25 23:16:27 +01:00
| Lenovo ThinkPad T14s AMD Gen 1 | `<nixos-hardware/lenovo/thinkpad/t14s/amd/gen1>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| Lenovo ThinkPad T410 | `<nixos-hardware/lenovo/thinkpad/t410>` |
Add Lenovo ThinkPad T420 profile
2019-11-02 11:52:58 +01:00
| Lenovo ThinkPad T420 | `<nixos-hardware/lenovo/thinkpad/t420>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| Lenovo ThinkPad T430 | `<nixos-hardware/lenovo/thinkpad/t430>` |
| Lenovo ThinkPad T440s | `<nixos-hardware/lenovo/thinkpad/t440s>` |
| Lenovo ThinkPad T440p | `<nixos-hardware/lenovo/thinkpad/t440p>` |
| Lenovo ThinkPad T450s | `<nixos-hardware/lenovo/thinkpad/t450s>` |
| Lenovo ThinkPad T460s | `<nixos-hardware/lenovo/thinkpad/t460s>` |
| Lenovo ThinkPad T470s | `<nixos-hardware/lenovo/thinkpad/t470s>` |
| Lenovo ThinkPad T480s | `<nixos-hardware/lenovo/thinkpad/t480s>` |
| Lenovo ThinkPad T490 | `<nixos-hardware/lenovo/thinkpad/t490>` |
lenovo/thinkpad/t495: init from e495. The E495 and T495 are based on the same core Ryzen platform, so the E495 tweaks apply similarly to the T495. Tested on my own T495, works well.
2020-03-11 08:09:55 +01:00
| Lenovo ThinkPad T495 | `<nixos-hardware/lenovo/thinkpad/t495>` |
Add Lenovo X13 Yoga Gen 1
2021-02-06 18:03:00 +01:00
| Lenovo ThinkPad X113 Yoga | `<nixos-hardware/lenovo/thinkpad/x13-yoga>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| 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 X260][] | `<nixos-hardware/lenovo/thinkpad/x260>` |
| Lenovo ThinkPad X270 | `<nixos-hardware/lenovo/thinkpad/x270>` |
Add Lenovo ThinkPad X280 profile
2019-12-31 12:43:42 +01:00
| Lenovo ThinkPad X280 | `<nixos-hardware/lenovo/thinkpad/x280>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| [Lenovo ThinkPad X1 (6th Gen)][] | `<nixos-hardware/lenovo/thinkpad/x1/6th-gen>` |
lenovo/thinkpad/x1/7th-gen: init
2020-05-16 22:12:10 +02:00
| [Lenovo ThinkPad X1 (7th Gen)][] | `<nixos-hardware/lenovo/thinkpad/x1/7th-gen>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| Lenovo ThinkPad X1 Extreme Gen 2 | `<nixos-hardware/lenovo/thinkpad/x1-extreme/gen2>` |
Add MS Surface Range to the README.md
2021-02-22 20:28:27 +01:00
| [Microsoft Surface Range][] | `<nixos-hardware/microsoft/surface>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| [Microsoft Surface Pro 3][] | `<nixos-hardware/microsoft/surface-pro/3>` |
Add MSI GS60 2QE (#224) Co-authored-by: Jörg Thalheim <Mic92@users.noreply.github.com>
2021-03-21 16:28:09 +01:00
| [MSI GS60 2QE][] | `<nixos-hardware/msi/gs60>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| PC Engines APU | `<nixos-hardware/pcengines/apu>` |
| [Raspberry Pi 2][] | `<nixos-hardware/raspberry-pi/2>` |
| [Samsung Series 9 NP900X3C][] | `<nixos-hardware/samsung/np900x3c>` |
Create separate directories for librem 13v3 and 15v3
2020-03-26 10:35:01 +01:00
| [Purism Librem 13v3][] | `<nixos-hardware/purism/librem/13v3>` |
| [Purism Librem 15v3][] | `<nixos-hardware/purism/librem/15v3>` |
thinkpad/x1-extreme/gen2: add module
2019-09-28 23:58:20 +02:00
| Supermicro A1SRi-2758F | `<nixos-hardware/supermicro/a1sri-2758f>` |
| Supermicro X10SLL-F | `<nixos-hardware/supermicro/x10sll-f>` |
| [Toshiba Chromebook 2 `swanky`][] | `<nixos-hardware/toshiba/swanky>` |
Add InfinityBook v4 (#159)
2020-05-06 00:20:10 +02:00
| [Tuxedo InfinityBook v4][] | `<nixos-hardware/tuxedo/infinitybook/v4>` |
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
[Acer Aspire 4810T]: acer/aspire/4810t
Add Asus TUF FX504GD
2020-05-20 16:35:48 +02:00
[Asus TUF FX504GD]: asus/fx504gd
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
[Apple MacBook Pro 10,1]: apple/macbook-pro/10-1
dell/g3/3779: init Add support for the Dell G3 3779.
2020-12-01 15:19:15 +01:00
[Dell G3 3779]: dell/g3/3779
Fix readme markdown syntax
2019-10-16 16:05:55 +02:00
[Dell XPS E7240]: dell/e7240
Add Dell XPS-7390 Profile (#128)
2019-10-30 20:15:22 +01:00
[Dell XPS 13 7390]: dell/xps/13-7390
add xps 13 (9343)
2020-01-09 05:49:26 +01:00
[Dell XPS 13 9343]: dell/xps/13-9343
Add entry for Dell XPS 13 9310 to README
2020-11-15 20:32:45 +01:00
[Dell XPS 13 9310]: dell/xps/13-9310
README: Add Dell XPS 13 9360 profile (#104) And reorder other XPS 13.
2019-04-26 19:43:47 +02:00
[Dell XPS 13 9360]: dell/xps/13-9360
dell/xps/13-9370: init
2018-10-19 15:45:05 +02:00
[Dell XPS 13 9370]: dell/xps/13-9370
README: Add Dell XPS 13 9360 profile (#104) And reorder other XPS 13.
2019-04-26 19:43:47 +02:00
[Dell XPS 13 9380]: dell/xps/13-9380
Revert "xps-15-7590: convert wiki to markdown." This reverts commit 77983d16f6ddcbdaf65d7656e82d39669095be6f. apparently github can link to wiki text fine.
2020-02-04 13:04:46 +01:00
[Dell XPS 15 7590]: dell/xps/15-7590
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
[Dell XPS 15 9550]: dell/xps/15-9550
add xps 9560 root readme to be able to easily find
2020-02-05 11:47:52 +01:00
[Dell XPS 15 9560]: dell/xps/15-9560
[Dell XPS 15 9560, intel only]: dell/xps/15-9560/intel
[Dell XPS 15 9560, nvidia only]: dell/xps/15-9560/nvidia
google/pixelbook: init
2020-05-07 16:12:35 +02:00
[Google Pixelbook]: google/pixelbook
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
[Inverse Path USB armory]: inversepath/usbarmory
ThinkPad X1 gen6 -> ThinkPad X1 (6th Gen)
2018-09-02 10:47:48 +02:00
[Lenovo ThinkPad X1 (6th Gen)]: lenovo/thinkpad/x1/6th-gen
lenovo/thinkpad/x1/7th-gen: init
2020-05-16 22:12:10 +02:00
[Lenovo ThinkPad X1 (7th Gen)]: lenovo/thinkpad/x1/7th-gen
Add Lenovo X13 Yoga Gen 1
2021-02-06 18:03:00 +01:00
[Lenovo ThinkPad X13 Yoga]: lenovo/thinkpad/x13-yoga
README: Add Lenovo ThinkPad x260
2018-08-30 14:59:11 +02:00
[Lenovo ThinkPad X260]: lenovo/thinkpad/x260
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
[Microsoft Surface Pro 3]: microsoft/surface-pro/3
Add MSI GS60 2QE (#224) Co-authored-by: Jörg Thalheim <Mic92@users.noreply.github.com>
2021-03-21 16:28:09 +01:00
[MSI GS60 2QE]: msi/gs60
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
[Raspberry Pi 2]: raspberry-pi/2
[Samsung Series 9 NP900X3C]: samsung/np900x3c
[Purism Librem 13v3]: purism/librem/13v3
README.md: fix librem link
2020-06-21 15:32:53 +02:00
[Purism Librem 15v5]: purism/librem/15v5
Add to README.md, redo the table in Markdown
2018-08-24 12:58:48 +02:00
[Toshiba Chromebook 2 `swanky`]: toshiba/swanky
README.md: add missing link
2020-05-17 09:07:37 +02:00
[Tuxedo InfinityBook v4]: nixos-hardware/tuxedo/infinitybook/v4
Add parallel test runner The new test runner will evaluate all test profiles from the README.md in parallel in separate nix-build processes. Since we do not load all processes into one process, this also helps saving memory.
2020-02-19 12:01:02 +01:00
## How to contribute a new device profile
1. Add your device profile expression in the appropriate directory
Added e470 to flake.nix and changing contributing section in README.md
2020-09-27 17:21:23 +02:00
2. Link it in the table in README.md and in flake.nix
Add parallel test runner The new test runner will evaluate all test profiles from the README.md in parallel in separate nix-build processes. Since we do not load all processes into one process, this also helps saving memory.
2020-02-19 12:01:02 +01:00
3. Run ./tests/run.py to test it. The test script script will parse all the profiles from the README.md
Reference in a new issue Copy permalink