summaryrefslogtreecommitdiffstats
path: root/keyboards/box75/readme.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.volpato@usp.br>2020-12-17 02:26:03 -0300
committerGitHub <noreply@github.com>2020-12-16 21:26:03 -0800
commitd82ab56a14fa9986a7651e6be78a73d10b5629df (patch)
tree9f8e7fdce463ddd242ef5b32de6a2913dc6eecfb /keyboards/box75/readme.md
parent14024fabeba025180b7a6be5bba0c8a99f31f619 (diff)
[Keyboard] Box75 (#10949)
* Initial BOX75 PCB v1.0.6 PCB support * New prototype firmware * Correct column pin assignment * Update README * Update keyboards/box75/config.h Remove USB description Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/box75/rules.mk Remove comment lines from BLUETOOTH_ENABLE and AUDIO_ENABLE Co-authored-by: Ryan <fauxpark@gmail.com> * Add VIA support * Remove KC_NO define and use traditional one * Update keyboards/box75/keymaps/default/keymap.c Move KC_HOME location on keymap.c Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/box75/box75.h Move HOME key location on keymap.c Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Changed F13 to print screen in default VIA firmware Co-authored-by: Gondolindrim <alvaro.augusto.volpato@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'keyboards/box75/readme.md')
-rw-r--r--keyboards/box75/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/box75/readme.md b/keyboards/box75/readme.md
new file mode 100644
index 0000000000..881eb750cf
--- /dev/null
+++ b/keyboards/box75/readme.md
@@ -0,0 +1,18 @@
+# BOX75 QMK firmware folder
+
+## Introduction
+
+This is the QMK firmware repository for the BOX75, a keyboard designed by [Lin Design Studio](https://www.instagram.com/lin_designstudio/?hl=en). The PCB was designed by [Gondolindrim](https://github.com/Gondolindrim).
+
+The BOX75 is a 75% keyboard featuring a sleek exterior inspired by modern architecture. It supports MX-type switches only with no lighting options. Layout-wise, the BOX75 supports ISO layouts, split backspace and split right shift and three bottom row options (6u, 6.25u, 7u).
+
+As of november 2020, the only way to obtain a BOX75 is through the still upcoming Group Buy on [Novelkeys](http://novelkeys.xyz).
+
+## How to compile
+
+After setting up your build environment, you can compile the BOX75 default keymap by using:
+
+ make box75: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).
+