summaryrefslogtreecommitdiff
path: root/keyboards/bigseries/4key/readme.md
diff options
context:
space:
mode:
authorCole Markham <github@themarkhams.us>2018-08-19 14:29:03 -0500
committerDrashna Jaelre <drashna@live.com>2018-08-19 12:29:03 -0700
commitfe687af54d9a6810ded8bb4dd959eca9fe3e847c (patch)
tree608a924ab6d8ec2a7895e5a502f70ffea1a7daa6 /keyboards/bigseries/4key/readme.md
parenta18cd1b2b693a1e4eeaf1715f6ffe53d70dd9ee4 (diff)
Keyboard: Add Big Series 2-, 3-, and 4-key boards (#3669)
* Implement magic 8-ball mode for big series switch * LED Testing * Add Ctrl+Alt+Del key mapping * Add Windows lock (win+L) layout. * Add Big Series 3-key * Add Big Series 4-key * Add Big Series 2-key * Fix layout mapping for Big Series 3u * Fix merge-conflict. * Refactor bigseries boards into a single folder
Diffstat (limited to 'keyboards/bigseries/4key/readme.md')
-rw-r--r--keyboards/bigseries/4key/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/bigseries/4key/readme.md b/keyboards/bigseries/4key/readme.md
new file mode 100644
index 0000000000..ec40e83f2c
--- /dev/null
+++ b/keyboards/bigseries/4key/readme.md
@@ -0,0 +1,15 @@
+# Big Series Keyboard
+
+![Big Series 4-Key](https://woodkeys.click/wp-content/uploads/2017/09/BigSeries_4u_with_keys_2018-Apr-01_04-54-09AM-000_CustomizedView38438685666_png.png)
+
+A PCB for the Big Series Switch by [NovelKeys](https://novelkeys.xyz). Available in 1, 2, 3, and 4 switch versions from [Woodkeys.click](https://woodkeys.click/product-category/big-series/).
+
+Keyboard Maintainer: [Cole Markham](https://github.com/colemarkham) / [Woodkeys.click](https://woodkeys.click)
+Hardware Supported: Big Series PCBs
+Hardware Availability: [Woodkeys.click](https://woodkeys.click), [NovelKeys](https://novelkeys.xyz)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make bigseries/4key:default
+
+See [build environment setup](https://docs.qmk.fm/install-build-tools) then the [make instructions](https://docs.qmk.fm/build-compile-instructions) for more information.