aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas James <Eele1Ephe7uZahRie@tutanota.com>2025-04-14 16:11:36 +1000
committerNicolas James <Eele1Ephe7uZahRie@tutanota.com>2025-04-14 16:11:36 +1000
commitd093751d6e2d05ab74d8c5c948e128cadaf281b7 (patch)
tree403509be27269ab64bca23f0ac87f072b6c40601
parent329cd3a67df6b724f082b1c9052bb4b108335992 (diff)
Update README.md with kernel build instructionsHEADmain
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5564fc0..dc88d4f 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,14 @@ To download the latest available release, clone this repository.
$ cd ./fastmouse
```
+First, you need to setup the kernel build in `kernel/` to whatever suits your needs.
+If you don't know what to do here, just save the defaults of menuconfig via:
+```console
+ $ cd ./linux
+ $ make menuconfig
+ $ cd ../
+```
+
We use cmake to as our build system, which consists of three steps. First, cmake
will attempt to build fastmouse with a test runner via googletest. If this succeeds,
cmake will make sure that all tests pass before moving on to the second step: attempting