Update CODE_OF_CONDUCT.md

[qmk_firmware.git] / keyboards / jj40 / README.md

diff --git a/keyboards/jj40/README.md b/keyboards/jj40/README.md
index 03b7533de01f02db0b9074e686823f2bde6678a7..39e871d87357b8110aab1d0d5bd26940195f4e59 100644 (file)
--- a/keyboards/jj40/README.md
+++ b/keyboards/jj40/README.md
@@ -10,7 +10,7 @@ Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj4
 
 Make example for this keyboard (after setting up your build environment):
 
-    make jj40-program
+    make jj40:default:program
 
 See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
 
@@ -18,13 +18,24 @@ Note that this is a complete replacement for the firmware, so you won't be
 using Bootmapper Client to change any keyboard settings, since not all the
 USB report options are supported.
 
-In addition you may need the AVR toolchain and `bootloadHID` for flashing:
+In addition you may need the AVR toolchain and `bootloadHID` ([GitHub repo](https://github.com/whiteneon/bootloadHID)) for flashing:
 
+For macOS:
 ```
 $ brew cask install crosspack-avr
 $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
 ```
 
+For Linux:
+```
+$ sudo apt install libusb-dev
+$ wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz
+$ tar -xzf bootloadHID.2012-12-08.tar.gz
+$ cd bootloadHID.2012-12-08/commandline
+$ make
+$ sudo cp bootloadHID /usr/bin
+```
+
 In order to use the `./program` script, which can reboot the board into
 the bootloader, you'll need Python 2 with PyUSB installed:
 
@@ -32,8 +43,8 @@ the bootloader, you'll need Python 2 with PyUSB installed:
 $ pip install pyusb
 ```
 
-If you prefer, you can just build it and flash the firmware directly with
-`bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
+If you prefer (or are having issues with a `program` flash), you can just build it (`make jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with
+`bootloadHID` if you boot the board while holding down `Backspace` (`Top Right Key`) to keep it
 in the bootloader:
 
 ```
@@ -41,9 +52,16 @@ $ make jj40
 $ bootloadHID -r jj40_default.hex
 ```
 
+For Windows 10:
+Windows sometimes doesn't recognize the jj40. The easiest way of flashing a new layout is probably using [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
+1. Go to Windows Device Manager and find the keyboard (plug it in while holding down `Backspace` (`Top Right Key`)). It can be found under Human Interface Devices or under Keyboards.
+2. Go to properties and the Details tab to find the hardware ID. You want the VID and the PID (code after the underscore). Plug them into HIDBootFlash and hit Find Device.
+3. Use `make jj40:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device.
+
+
 ## Troubleshooting
 
-1. Try plugging the board in while pressing `L_Ctrl`. This will force it
+1. Try plugging the board in while pressing `Backspace` (`Top Right Key`). This will force it
    to boot only the bootloader without loading the firmware. Once this is
    done, just reflash the board with the original firmware.
 2. Sometimes USB hubs can act weird, so try connecting the board directly