summaryrefslogtreecommitdiff
path: root/keyboards/southpole/readme.md
diff options
context:
space:
mode:
authorf00_B34rd <ericduns@gmail.com>2019-01-27 19:05:11 -0700
committerDrashna Jaelre <drashna@live.com>2019-01-27 18:05:11 -0800
commite0e8097162d92d337c0f4c6df50f3f9a7ca8e169 (patch)
treeac6012953ad36c3ec79b410b72af94a6e66b67bf /keyboards/southpole/readme.md
parent5eba88809e24f371252aaca11c465332d68948fc (diff)
downloadqmk_firmware-e0e8097162d92d337c0f4c6df50f3f9a7ca8e169.tar.gz
qmk_firmware-e0e8097162d92d337c0f4c6df50f3f9a7ca8e169.zip
[Keyboard] Add Southpole keyboard (#4946)
* Added southpole keyboard added southpole keyboard folder and files including keymaps folder. Keymaps have errors and will not compile yet * Add files via upload added manufacturer and product name and description * Update config.h * Add files via upload changed formating added layer * cleaned up files, fixed foobeard keymap, and added maker info * fixed keymap files * Update keyboards/southpole/keymaps/foobeard/keymap.c Co-Authored-By: ericduns <ericduns@gmail.com> * Update keyboards/southpole/keymaps/default/keymap.c Co-Authored-By: ericduns <ericduns@gmail.com> * made changes fixing outdated lines and added readme.md * made requested changes for pr to all files * removed vs code and added new line to southpole.h
Diffstat (limited to 'keyboards/southpole/readme.md')
-rw-r--r--keyboards/southpole/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/southpole/readme.md b/keyboards/southpole/readme.md
new file mode 100644
index 0000000000..4ea99ad349
--- /dev/null
+++ b/keyboards/southpole/readme.md
@@ -0,0 +1,13 @@
+# Southpole
+[Southpole](https://imgur.com/a/MZ2wdYt)
+
+PCB designed by u/waxpoetic for a southpaw style board with an hhkb style layout.
+
+Keyboard Maintainer: ericduns
+Hardware Supported: Teensy 2.0
+
+Make example for this keyboard (after setting up your build environment):
+
+ make southpole: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). \ No newline at end of file