aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/jj4x4/tools/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/jj4x4/tools/README.md')
-rw-r--r--keyboards/jj4x4/tools/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/jj4x4/tools/README.md b/keyboards/jj4x4/tools/README.md
new file mode 100644
index 000000000..081984ed4
--- /dev/null
+++ b/keyboards/jj4x4/tools/README.md
@@ -0,0 +1,16 @@
+# JJ40 Tools
+
+## usb_detach.c
+
+When trying to flash on Linux, you may encounter a "Resource Unavailable" error. This means that Linux's HID driver has taken exclusive control of the keyboard, and the program script can't flash it.
+This program can force Linux to give up a device, so that the programming script can reset it.
+
+### To compile:
+```
+gcc usb_detach.c -o usb_detach
+```
+
+### To run:
+1. Use `lsusb` to discover the Bus and Device numbers for your keyboard.
+2. Run the program: `sudo ./usb_detach /dev/bus/usb/<BUS>/<DEVICE>`.
+3. Build and program the firmware as normal.