aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ckeys/washington/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ckeys/washington/readme.md')
-rw-r--r--keyboards/ckeys/washington/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/ckeys/washington/readme.md b/keyboards/ckeys/washington/readme.md
new file mode 100644
index 000000000..a74934b3c
--- /dev/null
+++ b/keyboards/ckeys/washington/readme.md
@@ -0,0 +1,23 @@
+# Washington Macropad
+
+![Washington board](https://keypcb.xyz/Content/resources/washington-done.png)
+
+A macropad shaped like Washington State that supports a rotary encoder and an OLED display.
+
+* Keyboard Maintainer: [merlin04/KeyPCB](https://github.com/merlin04)
+* Hardware Supported: Washington Macropad
+* Hardware Availability: [cKeys.org](https://ckeys.org)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ckeys/washington: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).
+
+## PCB Design
+
+Download the files for the PCB [here.](https://keypcb.xyz/ViewPage/Washington#files)
+
+## Default Layout
+
+You can find the default layout in `washington/keymaps/default/keymap.c`