Skip to content

Commit 6e8756c

Browse files
committed
Add prequisites to readme
1 parent c1e2202 commit 6e8756c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ See `surface <subcommand> help` for more details.
2626

2727
_Hint:_ You can specify the subcommand by any unabiguous prefix of it, i.e. `surface perf` and `surface p` will both evaluate to `surface performance`.
2828

29+
## Prequisites
30+
31+
For this tool to work, you need a recent version of the [surface-acpi module][surface-acpi] e.g. via [Jake's kernel][surface-kernel] (for `latch` and `performance` sub-commands) and the [dGPU hot plug module][surface-shps] (for the `dgpu` sub-command).
32+
2933
## Installing
3034

3135
Have a look at the [releases](https://github.com/qzed/linux-surface-control/releases) page.
@@ -50,3 +54,7 @@ env CARGO_TARGET_DIR=target CARGO_INCREMENTAL=0 cargo deb
5054
where setting `CARGO_TARGET_DIR` is required to output the generated auto-completion files at the correct location for cargo-deb to pick up.
5155

5256
The final package can be found in `target/debian`.
57+
58+
[surface-acpi]: https://github.com/qzed/linux-surfacegen5-acpi
59+
[surface-kernel]: https://github.com/jakeday/linux-surface
60+
[surface-shps]: https://github.com/qzed/linux-surfacebook2-mshw0153

0 commit comments

Comments
 (0)