summaryrefslogtreecommitdiff
path: root/users/drashna/oled/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-12-29 20:17:34 -0800
committerGitHub <noreply@github.com>2021-12-29 20:17:34 -0800
commitc4551d7ef1ed2c1069f23cc8499b7c7fc30f3ecf (patch)
tree67dc381a45d59626132c4c59b71c4b36fa971f8b /users/drashna/oled/readme.md
parent1a8a842cfb3e87a82afb57ba29ca59c5fa6fe97b (diff)
[Keymap] Reorganization, cleanup and readmes for drashna code (#15617)
Diffstat (limited to 'users/drashna/oled/readme.md')
-rw-r--r--users/drashna/oled/readme.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/users/drashna/oled/readme.md b/users/drashna/oled/readme.md
new file mode 100644
index 0000000000..dbb8187d49
--- /dev/null
+++ b/users/drashna/oled/readme.md
@@ -0,0 +1,42 @@
+# OLED Display
+
+To disable the pre genrated oled display, add `CUSTOM_OLED_DRIVER = no` to your `rules.mk`.
+
+<!-- to do: add all the stuff -->
+## OLED Font
+
+My font file has multiple fonts and multiple logs integrated into the one file. And it uses the full 255 possible characters.
+
+In addition to the default font and logos:
+
+```c
+# define OLED_FONT_5X5
+# define OLED_FONT_AZTECH
+# define OLED_FONT_BMPLAIN
+# define OLED_FONT_CRACKERS
+# define OLED_FONT_EIN
+# define OLED_FONT_HISKYF21
+# define OLED_FONT_SQUASH
+# define OLED_FONT_SUPER_DIGG
+# define OLED_FONT_ZXPIX
+```
+
+```c
+# define OLED_LOGO_CORNE
+# define OLED_LOGO_GMK_BAD
+# define OLED_LOGO_GOTHAM
+# define OLED_LOGO_HUE_MANITEE
+# define OLED_LOGO_LOOSE
+# define OLED_LOGO_SETS3N
+# define OLED_LOGO_SKEEB
+```
+
+Additionally, the font file allows for external oled font files, instead. This allows for additional files that cannot be hosted in the QMK Repo.
+
+## Display
+
+A picture is worth a thousand words. So here are two:
+
+![Right](https://i.imgur.com/4XFOVKBl.jpg)
+
+![Left](https://i.imgur.com/W5RX4pAl.jpg)