Updates to keymap, added STL's and keymap guide

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.vscode

README.md

@@ -1 +1,147 @@
-# corne-config
+# dancard32/corne-config
+
+<div align="center">
+
+[![Dan Card](https://img.shields.io/static/v1?label=DanCard32&message=profile&color=blue&logo=github)](https://github.com/dancard32)
+[![stars - corne-config](https://img.shields.io/github/stars/dancard32/corne-config?style=social)](https://github.com/DanCard32/corne-config)
+[![forks - corne-config](https://img.shields.io/github/forks/dancard32/corne-config?style=social)](https://github.com/dancard32/corne-config)
+[![GitHub tag](https://img.shields.io/github/tag/dancard32/corne-config?include_prereleases=&sort=semver)](https://github.com/DanCard32/corne-config/releases/)
+[![issues - homelab](https://img.shields.io/github/issues/dancard32/corne-config)](https://github.com/dancard32/homelab/issues)
+
+</div>
+
+![Corne Overview](imgs/CORNE_OVERVIEW.png)
+
+## Table of Contents
+
+- [dancard32/corne-config](#dancard32corne-config)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Features](#features)
+    - [Assembling the Corne Case](#assembling-the-corne-case)
+    - [My Keycap Layout](#my-keycap-layout)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Acknowledgements](#acknowledgements)
+  - [Contact or Support](#contact-or-support)
+
+## Getting Started
+
+There are four STL's to print (five if you are printing the trackpad) in the `stls` folder:
+
+```bash
+stls
+├── BOT_TRACKPAD.stl
+├── LEFT_BOTTOM_PLATE.stl
+├── LEFT_VIEW.stl
+├── RIGHT_BOTTOM_PLATE.stl
+└── RIGHT_VIEW.stl
+```
+
+Recommended print settings:
+
+- 50% infill
+- 0.2mm layer height
+- No support material (support is required for printing the trackpad)
+
+The bill of materials are as follows:
+
+- PCB board (left and right) - $35
+- nice!nano v2.0 (x2) - $25/ea
+- nice!view (x2) - $20/ea
+- Tenting Feet (x4) - $15
+- Lithium Battery 750mAh (x2) - $6/ea
+- Kailh Low Profile Choc Switches (x42) - $5.50/10ea
+- 8mm Magnets - $14
+- M2 Screw set - $10
+- MagSafe Adapter Ring - $10
+- Keycap set - $30 (variable)
+
+The majority of parts were source from [Typeractive](https://typeractive.xyz/), the remaining parts being [Cirque Trackpad 40mm](https://www.mouser.com/ProductDetail/Cirque/TM040040-2024-301?qs=sGAEpiMZZMu3sxpa5v1qrmePy6bg6o9mSWgtNQf0SXM%3D), [M2 Screw set](https://www.amazon.com/dp/B0B93G1H9L?ref=ppx_yo2ov_dt_b_fed_asin_title), [8mm x 3mm Magnets](https://www.amazon.com/dp/B0CSW7GQFB?ref=ppx_yo2ov_dt_b_fed_asin_title&th=1), [MagSafe Adapter Ring](https://www.amazon.com/dp/B09PG57NXN?ref=ppx_yo2ov_dt_b_fed_asin_title),
+
+**Total Cost** ~ $230
+
+### Features
+
+This case is designed to have an extended battery, MagSafe adapter mounting, tenting feet and magnets to align the two halves of the case. This case still has some room for improvement such as some updates to the holes to the power and reset buttons, the side being thin, and aligning the view cases with the side etc. For now though I am happy with the results and may update this eventually as use cases change.
+
+### Assembling the Corne Case
+
+With the parts printed, use either M2 heat inserts or an M2 nut and a solder iron to place the nuts in place
+
+![M2 Insert](imgs/M2_INSERT.png)
+
+**Note:** Make sure that you are able to thread into *all* the holes before final assembly
+
+Next bolt the view cover in place
+
+![View bolt](imgs/VIEW_BOLT.png)
+
+Now bolt the case to the PCB
+
+![Case Bolt](imgs/CASE_BOLT.png)
+
+Add the case magnets
+
+![Magnet Insert](imgs/MAGNET_INSERT.png)
+
+Lastly add the mounting and feet
+
+![Mounting](imgs/MOUNTING.png)
+
+**Optional** Currently there is limited support for trackpad support, this case was designed in anticipation for trackpad support, but it is not currently implemented.
+
+![Trackpad Mount](imgs/TRACKPAD_MOUNT.png)
+
+Flash the board using the generated assets in the pipeline build. An in-depth guide on how to do this can be found from Joe Scotto's [How to Build a Wireless Corne Keyboard](https://www.youtube.com/watch?v=FJgvi7WShxY&t=721s). If you want to reflash the board with an updated firmware double press the reset button and re-connect.
+
+Add your switches and keycaps and there you go, your endgame Corne build is now complete!
+
+![CORNE Finished](imgs/CORNE_FINISHED.png)
+
+Magnet Aligned Case
+![Core Magnetic Mount](imgs/CORNE_MAGNET_MOUNT.png)
+
+MagSafe mounting
+![Corne Magsafe Mount](imgs/CORNE_MAGSAFE_MOUNT.png)
+
+### My Keycap Layout
+
+Base Layer:
+
+![Base Layer](imgs/KEYS_BASE.png)
+
+Low Layer:
+
+![Low Layer](imgs/KEYS_LOW.png)
+
+Up Layer:
+
+![Up Layer](imgs/KEYS_UP.png)
+
+This is my personal keycap layout, feel free to use it as your own. I use a Windows laptop for work development and Macbook for personal work and schooling so I found this is a general good all purpose layout
+
+## Contributing
+
+Feel free to contribute to this project! Clone/Fork this repository and if you come across an issue feel free to open an issue (using the Bug or Feature request templates). If you have any changes and would like to merge into the main branch create a merge review and I will look over when I have time!
+
+## License
+
+No license, all of this is based upon open-source and as such this entire repository is available as well. I would like to keep this is open-source, I just wish for some acknowledgement if you ever use my designs and mappings :)
+
+However, I would greatly appreciate it if you were to ...
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/dancard32)
+
+## Acknowledgements
+
+Show appreciation for and acknowledge the incredible help from the following community content creators:
+
+- Josean Martinez - [YouTube](https://www.youtube.com/@joseanmartinez)
+- Joe Scotto - [YouTube](https://www.youtube.com/@joe_scotto)
+- ZMK Dev Team - [Github](https://github.com/zmkfirmware/zmk), [ZMK.dev](https://zmk.dev/)
+- [r/crkbd](https://www.reddit.com/r/crkbd/)
+
+## Contact or Support
+
+If you are running into any issues first try forums to see if it is hardware specific - I doubt that I will enough time to directly respond to all invoices. If you are unable to pin-point an easy fix please open an issue as either a bug or feature for me to see. If it is security related, please email me at <[email protected]>

config/corne.keymap

@@ -18,12 +18,12 @@
 // |  TAB |  Q  |  W  |  E  |  R  |  T  |   |  Y  |  U   |  I  |  O   |  P   | =/+  |
 // | SHFT |  A  |  S  |  D  |  F  |  G  |   |  H  |  J   |  K  |  L   |  ;/: | '/"  |
 // | CTRL |  Z  |  X  |  C  |  V  |  B  |   |  N  |  M   | ,/< |  ./> |  /?  | -/_  |
-//                    | GUI | CMD | LWR |   | RSE | SPACE| BSPC|
+//                    | ALT | LWR | SPACE | | BSPC| RSE | CMD |
                         bindings = <
-   &kp TAB   &kp Q &kp W &kp E &kp R &kp T   &kp Y &kp U  &kp I &kp O &kp P    &kp EQUAL
-   &kp LSHFT &kp A &kp S &kp D &kp F &kp G   &kp H &kp J  &kp K &kp L &kp SEMI &kp SQT
-   &kp LCTRL &kp Z &kp X &kp C &kp V &kp B   &kp N &kp M  &kp COMMA &kp DOT &kp FSLH &kp MINUS
-                        &kp LALT &kp LGUI &mo 1   &mo 2 &kp SPACE &kp BSPC
+   &kp TAB   &kp Q &kp W &kp E &kp R &kp T      &kp Y &kp U  &kp I &kp O &kp P    &kp EQUAL
+   &kp LSHFT &kp A &kp S &kp D &kp F &kp G      &kp H &kp J  &kp K &kp L &kp SEMI &kp SQT
+   &kp LCTRL &kp Z &kp X &kp C &kp V &kp B      &kp N &kp M  &kp COMMA &kp DOT &kp FSLH &kp MINUS
+                &kp LALT &mo 1 &kp SPACE        &kp BSPC &mo 2 & kp RGUI
                         >;
                 };
                 lower_layer {
@@ -32,11 +32,12 @@
 // | CAPS |  1  |  2  |  3  |  4  |  5  |   |  6  |  7  |  8  |  9  |  0  |  \  |
 // | LCTRL|     |  ~  |  `  |  [  |  {  |   |  }  |  ]  |     |     |     |     |
 //                    | GUI | CMD |     |   | RSE | SPACE| BSPC|
+//                    | ALT |     | SPACE | | BSPC| ENT | CMD |
                         bindings = <
    &kp ESC   &kp EXCL &kp AT    &kp HASH &kp DLLR &kp PRCNT    &kp CARET &kp AMPS &kp STAR &kp LPAR &kp RPAR &kp PIPE
    &kp CAPS  &kp N1   &kp N2    &kp N3   &kp N4   &kp N5       &kp N6 &kp N7      &kp N8  &kp N9 &kp N0 &kp BSLH
    &kp LCTRL &trans   &kp TILDE &kp GRAVE &kp LBKT &kp LBRC    &kp RBRC &kp RBKT &trans &trans  &trans &trans
-                      &kp LALT  &kp LGUI &trans                &trans &kp SPACE &kp BSPC
+                &kp LALT &trans &kp SPACE        &kp BSPC &kp RET & kp RGUI
                         >;
                 };
 
@@ -45,12 +46,12 @@
 // |  ESC |  F1 |  F2  |  F3  |  F4  |  F5  |      | F6   |  F7   |  F8  | F9   | F10 |  F11 |
 // | SHFT | BT1 | BT2  | BT3  | BT4  | BT5cc|      | left | down  |  up  | right|     |  F12 |
 // | LCTRL|BTCLR| HOME |  END | PGUP | PGDN |      | PREV | PlayP | SKIP | mute | inc | dec  |
-//                    | GUI | CMD |  ENT   |                        |  | SPACE| BSPC|
+//                    | ALT | ENT | SPACE |         | BSPC |   | CMD |
                         bindings = <
    &kp ESC   &kp F1   &kp F2 &kp F3   &kp F4  &kp F5            &kp F6     &kp F7    &kp F8  &kp F9 &kp F10 &kp F11
    &kp LSHFT &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4 &kp LEFT   &kp DOWN  &kp UP  &kp RIGHT &kp N0 &kp F12
    &kp LCTRL &bt BT_CLR  &kp HOME &kp END &kp PG_UP &kp PG_DN       &kp C_PREV &kp C_PP  &kp C_NEXT &kp C_MUTE  &kp C_VOL_DN &kp C_VOL_UP
-                        &kp LALT &kp LGUI &kp RET               &trans     &kp SPACE &kp BSPC
+                        &kp LALT &kp RET &kp SPACE        &kp BSPC &trans & kp RGUI
                         >;
                 };
         };