summaryrefslogtreecommitdiffstats
path: root/keyboards/hs60/v1/readme.md
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-04 09:43:45 +0100
committerAlex Ong <the.onga@gmail.com>2019-01-04 09:43:45 +0100
commit2bb2977c133646c4e056960e72029270d77cc1eb (patch)
tree235d491f992121ac1716c5bf2fafb80983748576 /keyboards/hs60/v1/readme.md
parenta55c838961c89097ab849ed6cb1f261791e6b9b4 (diff)
parent47c91fc7f75ae0a477e55b687aa0fc30da0a283c (diff)
downloadqmk_firmware-2bb2977c133646c4e056960e72029270d77cc1eb.tar.gz
qmk_firmware-2bb2977c133646c4e056960e72029270d77cc1eb.tar.xz
Merge branch 'master' into debounce_refactor
# Conflicts: # tmk_core/common/keyboard.c
Diffstat (limited to 'keyboards/hs60/v1/readme.md')
-rw-r--r--keyboards/hs60/v1/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/hs60/v1/readme.md b/keyboards/hs60/v1/readme.md
new file mode 100644
index 000000000..9034e9b88
--- /dev/null
+++ b/keyboards/hs60/v1/readme.md
@@ -0,0 +1,22 @@
+HS60
+====
+
+[HS60](https://mechboards.co.uk/wp-content/uploads/2018/04/IMG_20180420_140353.jpg)
+
+This is a standard fixed layout 60% PCB. It comes in two varians, ISO and ANSI and support full per-key RGB.
+
+Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar)
+Hardware Supported: HS60 ISO and ANSI PCBs with Atmega 32u4
+Hardware Availability: https://mechboards.co.uk/shop/all/hs60-pcb/
+
+If you're using the [community layouts feature](https://docs.qmk.fm/#/feature_layouts) and using the 60_ansi layout, you need to make sure that you include this on your config.h to ensure that the RGB Matrix is properly configured:
+
+ #ifdef KEYBOARD_hs60
+ #define HS60_ANSI
+ #endif
+
+Make example for this keyboard (after setting up your build environment):
+
+ make hs60/v1:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.