summaryrefslogtreecommitdiff
path: root/keyboards/sck/osa/readme.md
diff options
context:
space:
mode:
authorJ.Flanagan <jrfhoutx@comcast.net>2019-10-05 12:44:55 -0500
committerDrashna Jaelre <drashna@live.com>2019-10-05 10:44:55 -0700
commit19b60c273ab63c250db748e5eead6baba88cd0d8 (patch)
tree72a0fa65515e4d25e099c3ae68250ed0a8e39184 /keyboards/sck/osa/readme.md
parentdbce3f648b342418f79de977068f2005d534cff7 (diff)
downloadqmk_firmware-19b60c273ab63c250db748e5eead6baba88cd0d8.tar.gz
qmk_firmware-19b60c273ab63c250db748e5eead6baba88cd0d8.zip
[Keyboard] Add OSA keyboard (#6849)
* initial commit restart of osa development * minor changes Minor changes mostly changing naming and comment out rgb modes * initial commit restart of osa development * minor changes Minor changes mostly changing naming and comment out rgb modes * more minor changes comment out some functions correct some spelling errors change some of the descriptive text * Minor Changes Minor changers per PR requests * Minor Changes Minor changes per PR suggestions * Major Changes Per PR suggestion from noroadsleft: - changed macro to LAYOUT_all in info.json, dualsplit/keymap.c and ocm/keymap.c, and osa.h - added osa.h macros for other layouts per suggestion and used suggested naming - changed naming of layout macros to correspond to macros and naming in default/keymap.c, dualsplit/keymap.c, ocm/keymap.c, splitbs/keymap.c, and splitrs/keymap.c - removed duplicate layers from all keymaps and edited per suggestions - compiled each keymap to check for and correct any potential errors. all compiled with no errors * Minor Change - fixed imgur image link in readme.md to be correct format * Minor Changes changes to macro layouts in osa.h changes to dualsplit/keymap.c - added arrows to layer 1 * Changes - Made changes to info.json to match osa.h - changes to osa.c enabling indicator LEDs - changed "dualsplit" directory name to "all" to match keymap naming in osa.h, info.json, and keymap.c - minor changes to all/keymap.c * Update keyboards/sck/osa/rules.mk Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/sck/osa/readme.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Changes to info.json - revert to info.json from version in b3b49c3 per requested changes
Diffstat (limited to 'keyboards/sck/osa/readme.md')
-rw-r--r--keyboards/sck/osa/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/sck/osa/readme.md b/keyboards/sck/osa/readme.md
new file mode 100644
index 0000000000..024df5cee6
--- /dev/null
+++ b/keyboards/sck/osa/readme.md
@@ -0,0 +1,19 @@
+# osa
+
+![osa](https://i.imgur.com/U2x7TQ8.jpg)
+
+About the OSA:
+
+The OSA was run as a private group buy of 20 units. It is an Alice layout keyboard based on the Open Source Alice files, altered by BlindAssassin111 based on input from the private group buy members.
+All case and other design files have been either reworked or created from scratch by BlindAssassin111. PCB was designed from scratch by BlindAssassin111.
+The OSA PCB is an ATMega32u4 powered, USB Type C, Alice compatible PCB and was created specifically for the OSA case, but with considerations to make it compatible with the Lubrigante acrylic cases (except for the Type C connector it should also be compatible with original TGR Alice cases).
+
+Keyboard Maintainer: [jrfhoutx](https://github.com/jrfhoutx)
+Hardware Supported: OSA PCB by BlindAssassin111, ATMEGA32u4
+Hardware Availability: Currently unavailable outside of the private group buy
+
+Make example for this keyboard (after setting up your build environment):
+
+ make sck/osa: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).