summaryrefslogtreecommitdiff
path: root/keyboards/7c8/framework/readme.md
diff options
context:
space:
mode:
authorSteven Nguyen <steven7c8@gmail.com>2021-02-27 21:30:28 -0800
committerGitHub <noreply@github.com>2021-02-28 16:30:28 +1100
commitec06ffe294c1f64d4214b9a5142428c17f83ef6e (patch)
tree592f626a2d42ee33145690e038142808b4dbb73a /keyboards/7c8/framework/readme.md
parent03ea478f205e37419032c15c16143c17a5d2b5ae (diff)
downloadqmk_firmware-ec06ffe294c1f64d4214b9a5142428c17f83ef6e.tar.gz
qmk_firmware-ec06ffe294c1f64d4214b9a5142428c17f83ef6e.zip
Add keyboard: 7c8/Framework (#11593)
* Add 7c8/framework keyboard * Update VIA framework.json definition * Code cleanup and styling to conform to QMK style guide * Code cleanup and moving some keymap definitions to a 'steven' keymap in order to create a cleaner default keymap for other users * Update keyboards/7c8/framework/config.h Remove #define DESCRIPTION Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/7c8/framework/config.h remove #define UNUSED_PINS Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/7c8/framework/framework.h Change layout name to existing layout name. Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/7c8/framework/framework.h Change layout name to existing layout name. Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/7c8/framework/framework.h Change layout name to existing layout name. Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/7c8/framework/keymaps/via/keymap.c change biton32 to get_highest_layer Co-authored-by: Drashna Jaelre <drashna@live.com> * change vendor ID from 0x07c8 to 0x77c8, which is unused * delete VIA .json definition from via keymap folder * Change framework_grid to LAYOUT_ortho_5x12 in default keymap.c * remove framework.json from 'steven' keymap folder * cleanup * Update keyboards/7c8/framework/config.h 0x77c8 -> 0x77C8 Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/7c8/framework/readme.md')
-rw-r--r--keyboards/7c8/framework/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/7c8/framework/readme.md b/keyboards/7c8/framework/readme.md
new file mode 100644
index 0000000000..5f29743aad
--- /dev/null
+++ b/keyboards/7c8/framework/readme.md
@@ -0,0 +1,30 @@
+# Framework
+
+![Framework](https://i.imgur.com/njrHoH1.jpeg)
+
+## Features
+
+* All through-hole components (except Kailh hotswap sockets)
+* QMK firmware with VIA support
+* Rotary encoder
+* Hotswappable switches
+* FR-4 and acrylic sandwich construction
+* USB Type-C
+* Supports MIT (one 2u), grid (two 1u), and two 2u space keys
+
+## Info
+
+* Keyboard maintainer: [Steven Nguyen](https://github.com/stevennguyen)
+* Hardware supported: Framework
+* Hardware availability: [Steven Nguyen](https://github.com/stevennguyen)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make 7c8/framework:default # default keymap
+ make 7c8/framework:via # via-compatible keymap
+
+Flashing example for this keyboard:
+
+ make 7c8/framework:default:flash
+
+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