summaryrefslogtreecommitdiff
path: root/keyboards/idobo/keymaps/egstad/readme.md
diff options
context:
space:
mode:
authorJordan Egstad <jordanegstad@gmail.com>2020-11-09 11:54:15 -0800
committerGitHub <noreply@github.com>2020-11-09 11:54:15 -0800
commit84ca67f1583ec1cc3689bd92a602bd8fdc6ad2a6 (patch)
tree13b5a625c65e8ecb6b48b9207adf23186e261e12 /keyboards/idobo/keymaps/egstad/readme.md
parentcb80b59e9343c014389d56317e93f4de71d07a9a (diff)
[Keymap] idobo:egstad (#10783)
* feat: new keymapping for idobo * fix: added licenses. converted int to uint8_t where applicable * fix: addressed zvecr stylistic enhancements * fix: replaced rgblight_sethsv with rgblight_sethsv_noeeprom
Diffstat (limited to 'keyboards/idobo/keymaps/egstad/readme.md')
-rw-r--r--keyboards/idobo/keymaps/egstad/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/idobo/keymaps/egstad/readme.md b/keyboards/idobo/keymaps/egstad/readme.md
new file mode 100644
index 0000000000..2de44ad9cc
--- /dev/null
+++ b/keyboards/idobo/keymaps/egstad/readme.md
@@ -0,0 +1,17 @@
+# Egstad's Idobo
+
+## LEDs
+By default, LEDs are enabled. There is a short bootup animation (`bootupAnimation()`) to indicate that the keyboard has powered up correctly.
+
+On each keypress, the LEDs hue increases. This increase is determined the the `RGBLIGHT_HUE_STEP` value, which is assigned in `../config.h` (parent idobo directory). My local copy has this value set to `1`, so the incremental color shift is rather slow.
+
+
+## Keeping up to date
+To update your fork’s master, run the following, hitting the Enter key after each line:
+
+```bash
+git checkout master
+git fetch upstream
+git pull upstream master
+git push origin master
+```