From c2e1ecf8e18ccaa7833188b3bbf4791c76cc0555 Mon Sep 17 00:00:00 2001
From: aksys-dev <79077611+aksys-dev@users.noreply.github.com>
Date: Thu, 18 Feb 2021 13:26:17 +0800
Subject: [PATCH] Update README.md

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9a6f26b5561e..38ba20c39ab9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
-# hid-aksys
\ No newline at end of file
+# Vibrator driver for HHG device
+## How to merge the driver into kernel source tree
+
+ 1. Copy \${this_project}/drivers/hid/hid-aksys.c into \${your_kernel_root}/drivers/hid/
+
+ 2. Compare and merge \${this_project}/drivers/hid/hid-ids.h into \${your_kernel_root}/drivers/hid/hid-ids.h :
+ Add the following code before the last line of this file
+
+    ```c
+        #define USB_VENDER_ID_AKSYS			0x1234
+        #define USB_DEVICE_ID_AKSYS_QRD		0x1000
+    ```
+
+ 3. Merge \${this_project}/drivers/hid/Kconfig into \${your_kernel_root}/drivers/hid/Kconfig :
+Add the following code before the last line of this file
+
+		config HID_AKSYS_QRD
+    		tristate "AKSys gamepad USB adapter support"
+    		depends on HID
+    		---help---
+    		Support for AKSys gamepad USB adapter
+
+    	config AKSYS_QRD_FF
+    		bool "AKSys gamepad USB adapter force feedback support"
+    		depends on HID_AKSYS_QRD
+    		select INPUT_FF_MEMLESS
+    		---help---
+    		Say Y here if you have a AKSys gamepad USB adapter and want to
+    		enable force feedback support for it.
+    		
+ 4. Merge \${this_project}/drivers/hid/Makefile into \${your_kernel_root}/drivers/hid/Makefile :
+ Add the following code at the end of this file
+
+		obj-$(CONFIG_HID_AKSYS_QRD)	+= hid-aksys.o
+		
+ 5. Modify your kernel's default build configuration file. Add the following two lines:
+
+        CONFIG_HID_AKSYS_QRD=m
+        CONFIG_AKSYS_QRD_FF=y