summaryrefslogtreecommitdiff
path: root/keyboards/handwired/xealousbrown/readme.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2020-10-25 15:23:42 +0000
committerGitHub <noreply@github.com>2020-10-25 15:23:42 +0000
commitad86894ae7d5fbb7aed697d9f576cd186bfd1c9c (patch)
treec5ffe570301b95699d93566d5b9453bda203a7ae /keyboards/handwired/xealousbrown/readme.md
parentaf455a8368dc564df51f9657b04932956ccf580b (diff)
Rename keyboard-level readmes to lower-case (#10759)
This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc.
Diffstat (limited to 'keyboards/handwired/xealousbrown/readme.md')
-rw-r--r--keyboards/handwired/xealousbrown/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/handwired/xealousbrown/readme.md b/keyboards/handwired/xealousbrown/readme.md
new file mode 100644
index 0000000000..970f9444c4
--- /dev/null
+++ b/keyboards/handwired/xealousbrown/readme.md
@@ -0,0 +1,17 @@
+# XealouS Brown
+
+My first handwired keyboard. Originally used TMK, now ported in full glory to QMK.
+
+Build log at:
+https://sites.google.com/site/xaelous/keyboards/handwired-keyboard
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/xealousbrown:default
+
+
+The brief list of speedhacks to make this keyboard blazing fast:
+1) bit-bash implementation of scanning rows, columns. Very short delay between pin waiting.
+2) Compiling with a few extra flags
+3) Eager-per-key Debouncing algorithm (no 5ms delay before message is sent)
+4) 1000hz polling