summaryrefslogtreecommitdiff
path: root/keyboards/iron180/readme.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.volpato@usp.br>2021-12-07 11:48:12 -0300
committerGitHub <noreply@github.com>2021-12-07 14:48:12 +0000
commit28e92536d46298229593c12406b503bf3bcbbede (patch)
tree26dafb81884df75d67794f5368b273113596582d /keyboards/iron180/readme.md
parent554cc86aebd9011efd30d708ed2a717aaf8f93f1 (diff)
downloadqmk_firmware-28e92536d46298229593c12406b503bf3bcbbede.tar.gz
qmk_firmware-28e92536d46298229593c12406b503bf3bcbbede.zip
Iron180 LED fix (#15411)
Diffstat (limited to 'keyboards/iron180/readme.md')
-rw-r--r--keyboards/iron180/readme.md25
1 files changed, 20 insertions, 5 deletions
diff --git a/keyboards/iron180/readme.md b/keyboards/iron180/readme.md
index 5f340c4251..1dbffae1d4 100644
--- a/keyboards/iron180/readme.md
+++ b/keyboards/iron180/readme.md
@@ -1,4 +1,6 @@
-# Iron180 QMK folder
+# Iron180 QMK firmware folder
+
+![iron180](https://i.imgur.com/zHcZoxa.png)
## Introduction
@@ -6,13 +8,26 @@ This is the QMK Firmware repository for the Iron180 PCB, a keyboard designed by
The Iron180 PCB is a F13 TKL PCB with ALPS switches support. It also supports in-switch single-color LEDs and a multi-layout design for default or 7U bottom row, ISO layout, split backspace and right shift.
-As of November 2020, the only way to obtain an Iron180 was through the [Group Buy](https://geekhack.org/index.php?topic=109513) which is already over and all spots were filled.
+As of november 2021, the Group Buy of Iron180 is already over and extras were not sold yet. See the [GB page](https://geekhack.org/index.php?topic=109513) for more information.
+
+## How to flash
+
+### Enter bootloader
+
+The DFU state in the bootloader can be accessed in 3 ways:
-## How to compile
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard with the key pressed;
+* **Physical reset button**: press the button on the front of the PCB, next to caps lock, for at least five seconds;
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available (ESCAPE key in layer 1 of the default layout);
-After setting up your build environment, you can compile the Iron180 default keymap by using:
+## Compile firmware and flash
+
+To build the default layout for this keyboard (after setting up your build environment), use:
make iron180:default
-See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+Then, after accessing the DFU state, use a tool like `dfu-util` or the QMK Toolbox to download that firmware into your PCB. To directly compile-and-flash the PCB after it is put into a DFU state, use
+ make iron180:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).