aboutsummaryrefslogtreecommitdiff
path: root/keyboards/for_science/readme.md
diff options
context:
space:
mode:
authorJonathan Dayton <jdayton3@users.noreply.github.com>2020-08-26 11:55:18 -0500
committerGitHub <noreply@github.com>2020-08-26 09:55:18 -0700
commit2f9eb4cd22777e369cf220594d2269d6cfa8fcb6 (patch)
tree0aec0dd89814027e147cf5669edb2b50587d49db /keyboards/for_science/readme.md
parentbad662b830bc5d93e244aec73d3115a65d7ccf17 (diff)
downloadqmk_firmware-2f9eb4cd22777e369cf220594d2269d6cfa8fcb6.tar.gz
qmk_firmware-2f9eb4cd22777e369cf220594d2269d6cfa8fcb6.zip
[Keyboard] For Science (#9607)
* Add a compiling layout based on minidox * Add the correct pins * Add old for science code * Update to 2020 standards * Get the keymap working * update config * Update pinout * Fix pins * Make requested changes * Add info.json for configurator * for science - PR comments * Apply suggestions from code review
Diffstat (limited to 'keyboards/for_science/readme.md')
-rw-r--r--keyboards/for_science/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/for_science/readme.md b/keyboards/for_science/readme.md
new file mode 100644
index 000000000..8fa399a10
--- /dev/null
+++ b/keyboards/for_science/readme.md
@@ -0,0 +1,18 @@
1# For Science
2
3![for_science](https://raw.githubusercontent.com/peej/for-science-keyboard/master/pcb.png)
4
5A split ergo 4x5 keyboard with 3 thumb keys where each half is smaller than the 100x100mm cheap PCB production size.
6Designed to be easy to build, it only supports serial communication over a TRRS cable and no LED support.
7The PCB is reversible, meaning that you use the same PCB for both the left and right halves and thus need two PCBs to create a full keyboard.
8
9* Keyboard Maintainer: [Peej](https://github.com/peej)
10* Hardware Supported: Pro Micro
11* Hardware Availability: [Github](https://github.com/peej/for-science-keyboard)
12
13Make example for this keyboard (after setting up your build environment):
14
15 make for_science:default
16
17See 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.
18Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).