summaryrefslogtreecommitdiff
path: root/keyboards/tominabox1/le_chiffre/readme.md
diff options
context:
space:
mode:
authorTJ <tom.campie@gmail.com>2022-07-23 19:03:41 -0500
committerGitHub <noreply@github.com>2022-07-23 17:03:41 -0700
commitc3df1775bc9a14b5a43c03d000f6765c119b44ee (patch)
tree53a8d65cf49d01df5897384fb8fb29a7a636e2ae /keyboards/tominabox1/le_chiffre/readme.md
parentf1ccd60458a83b575ec5f13af8b7e1b07587d9f3 (diff)
downloadqmk_firmware-c3df1775bc9a14b5a43c03d000f6765c119b44ee.tar.gz
qmk_firmware-c3df1775bc9a14b5a43c03d000f6765c119b44ee.zip
[Keyboard] Le Chiffre rev 2 and HE additions (#17377)
* chiffre refactor for new revisions * updated led matrix config * updated per suggestions * add tapdance enable * revert tapdance (none defined in the default keymaps) * clean up rules * add readme for HE * remove notes in readme * fix perm * fix perms * Fix spacing on readme * fix perm * fix perms again?
Diffstat (limited to 'keyboards/tominabox1/le_chiffre/readme.md')
-rw-r--r--keyboards/tominabox1/le_chiffre/readme.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/keyboards/tominabox1/le_chiffre/readme.md b/keyboards/tominabox1/le_chiffre/readme.md
index ea18546c61..d2d688289e 100644
--- a/keyboards/tominabox1/le_chiffre/readme.md
+++ b/keyboards/tominabox1/le_chiffre/readme.md
@@ -4,12 +4,18 @@
Le Chiffre (ironically, "the number" in French is a 30% keyboard designed by tominabox1. The purpose of the board is to provide a platform for MX and Choc ergo in one package for when ones wrists need a break. The board supports an RGB LED strip with DI on port F0. The board is also fitted with support for run-of-the-mill .91" OLED and EC11 rotary encoder.
+There are 3 PCB revisions: Rev 1 (Original), Rev 2 (P3D version sold with the Le Chiffre Plus), and HE (Hotswap Edition from Checkerboards.xyz).
+
+By default the OLED is **disabled**. This is to prevent issues with operation when one is not installed. Be sure to enable the OLED in the rules.mk file if you have one installed!
+
* Keyboard Maintainer: [TJ Campie](https://github.com/tominabox1)
-* Hardware Supported: Le Chiffre (source not available at this time)
+* Hardware Supported: [Le Chiffre](https://github.com/tominabox1/Le-Chiffre-Keyboard)
* Hardware Availability: Bring your own case.
Make example for this keyboard (after setting up your build environment):
- make tominabox1/le_chiffre:default
+ make tominabox1/le_chiffre/rev1:default
+ make tominabox1/le_chiffre/rev2:default
+ make tominabox1/le_chiffre/he: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).