summaryrefslogtreecommitdiff
path: root/keyboards/cipulot/ec_prox/jis/readme.md
diff options
context:
space:
mode:
authorCipulot <40441626+Cipulot@users.noreply.github.com>2023-03-23 11:09:50 +0100
committerGitHub <noreply@github.com>2023-03-23 10:09:50 +0000
commit15cb7ded76794a94fa7be3c2b8d3bad1607582aa (patch)
tree7cce57b344cc2acc5e262fcc2dc8cc24c58ffc69 /keyboards/cipulot/ec_prox/jis/readme.md
parent5428d922a54fe8172c17ccbf5e60c2b0162edd11 (diff)
EC ProX PCB (#20047)
* Add EC Pro X Addition of EC Pro X PCB series. This series comprises 2 versions: - ANSI/ISO - JIS The PCBs are different and are compatible only with their respective cases. * Moved from data driven row/col def to config def * Added project url in info.json * Implemented proper `LAYOUT_` changes * Removen unnecessary `.h` includes * Removal of `"w": 1` * Added `DISCHARGE_TIME` Addition of a `DISCHARGE_TIME` time. This is to ensure that the ghost capacitor that is the row strobed for the ADC read, is fully drained and doesn't carry charges that deviates the readings. Tested on multiple hardware and confirmed working and improving the readings, both in terms of stability and consistency for baseline noise. * Fixed keymap error in ordering * Update keyboards/cipulot/ec_prox/jis/readme.md Co-authored-by: Tom Barnes <barnestom@me.com> * Update keyboards/cipulot/ec_prox/ansi_iso/readme.md Co-authored-by: Tom Barnes <barnestom@me.com> * Removal of `info.json` lines as suggested * Update to comply with `_kb` and `_user` separation * Update keyboards/cipulot/ec_prox/jis/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update rules.mk --------- Co-authored-by: Tom Barnes <barnestom@me.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/cipulot/ec_prox/jis/readme.md')
-rw-r--r--keyboards/cipulot/ec_prox/jis/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/cipulot/ec_prox/jis/readme.md b/keyboards/cipulot/ec_prox/jis/readme.md
new file mode 100644
index 0000000000..f1fa471cc9
--- /dev/null
+++ b/keyboards/cipulot/ec_prox/jis/readme.md
@@ -0,0 +1,27 @@
+# EC Pro X JIS
+
+![EC Pro X JIS PCB](https://i.imgur.com/yJdPOcbh.png)
+
+Open source replacement PCB kit for the HHKB Pro 2 and Pro 3 keyboards using the JIS case.
+
+* Keyboard Maintainer: [cipulot](https://github.com/cipulot)
+* Hardware Supported: EC Pro X JP PCB
+* Hardware Availability: [EC Pro X](https://github.com/cipulot/EC-Pro-X)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cipulot/ec_prox/jis:default
+
+Flashing example for this keyboard:
+
+ make cipulot/ec_prox/jis: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical Boot0 pins**: Short the Boot0 pins on the back of the PCB while plugging in the keyboard
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available