From d9190f1d26b5f34a47ca828695ec66a3d23a4643 Mon Sep 17 00:00:00 2001
From: Geoffrey McRae <geoff@hostfission.com>
Date: Sat, 14 Nov 2020 15:01:24 +1100
Subject: [PATCH] [core] updated readme with requirements

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 6143e5b..35ec749 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,19 @@ allowing it to handle device resets directly without patching the running
 kernel. Simply modprobing the module is enough to enable the reset routines for
 all supported hardware.
 
+## Requirements
+
+Ensure your kernel has the following options enabled:
+
+```
+CONFIG_FTRACE=y
+CONFIG_KPROBLES=y
+CONFIG_PCI_QUIRKS=y
+CONFIG_KALLSYMS=y
+CONFIG_KALLSYMS_ALL=y
+CONFIG_FUNCTION_TRACER=y
+```
+
 ## Installing
 
 This module can be installed either using the standard `make`, `make install`