Add license and update readme

.vscode/settings.json

@@ -6,12 +6,15 @@
         "bspc",
         "BSPC",
         "CLCK",
+        "Colemak",
+        "corne",
         "DLLR",
         "dtsi",
         "FSLH",
         "gtoe",
         "homerow",
         "keymap",
+        "keymaps",
         "laao",
         "LALT",
         "LBKT",
@@ -33,6 +36,7 @@
         "rdae",
         "RSFT",
         "RSHFT",
-        "SHFT"
+        "SHFT",
+        "Sweept"
     ]
 }

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 dein Software
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,136 @@
-<https://nickcoutsos.github.io/keymap-editor/>
+# ZMK Configuration
+
+ZMK configuration for [swept-crkbd](https://github.com/AYM1607/swept-crkbd/) also compatible with [crkbd](https://github.com/foostan/crkbd) wireless version with [nice!nano](https://nicekeyboards.com/nice-nano/).
+
+This is a WIP layout based on Colemak DHm for using on Windows, taking in mind some Spanish accents, easy access to development symbols and JS/TS shortcuts.
+
+---
+
+## Menu
+
+- [Usage](#usage)
+- [Keyboard](#keyboard)
+- [About](#about)
+
+---
+
+## Usage
+
+### Turn on/off
+
+There's a small slider switch right underneath the USB-C connector which controls power. The keyboard is **OFF** when the sliders on both halves are on the left positions as shown in the following picture:
+
+TODO: add picture
+
+The keyboard is **ON** when the switch is slided to the right on both halves as shown in the following picture. Please note that for the halves to connect correctly, the both must be turned on as closely to THE SAME TIME as possible; it's okay if there's one or two seconds of difference but try to keep it to a minimum.
+
+TODO: add picture
+
+### Charge
+
+To charge your boards you must put the half you want to charge in the ON position and connect it to a power source (it can be your computer) through the USB port.
+
+You know it's charging if you see an orange light like the one in the following picture. The light turns off when charging is done.
+
+TODO: add picture
+
+### Reset
+
+TODO: add picture
+
+### Configure
+
+The wireless version of the Swept use ZMK as their firmware, you can find out more at [ZMK docs](https://zmk.dev/docs)
+
+These pages will guide you to create your own keymap (follow them after your user-setup) [customization](https://zmk.dev/docs/customization) and [keymaps](https://zmk.dev/docs/features/keymaps)
+
+Once you make changes to your keymap, you can download the firmware from the github actions tab of your repo. Since the keyboards come pre-flashed by me, you only need to flash the left half to change your keymaps. You can do it by following these steps:
+
+1. Turn off both halves.
+
+2. Plug in the left half into your computer (without turning it on)
+
+3. "Double tap" the reset button, play around with the timing between taps since this might not work the first time. If you have trouble with this step, re-plug your board and try again, you might even need to use a different cable or port on your computer. You know this works if you see a blue light fading on and off coming from the nice nano.
+
+4. After the previous step you should see a new storage device in your computer called nice!nano, as shown in the picture below. Drag and drop (or copy and paste) the firmware file `corne_left-nice_nano_v2-zmk.uf2`  which you should have generated and downloaded by following the guides linked above.
+
+5. Wait until the storage device automatically disappears from your computer, this should not take longer than a few seconds.
+
+6. Unplug the board from your computer
+Follow the procedure in "How to turn my keyboard on?"
+
+⇧ [Back to menu](#menu)
+
+---
+
+## Keyboard
+
+### Conventions
+
+Icons used to describe some modifiers and actions
+
+|Key|Description|
+|:-:|-----------|
+| ◆ | Win/GUI |
+| ⌃ | Control |
+| ⌥ | Alt |
+| ⇧ | Shift |
+| 🄰 | Caps Lock|
+| ⎋ | Esc |
+| ↹ | Tab |
+| ⌫ | Backspace |
+| ⌦ | Del |
+| ⏎ | Return |
+| ⇪ | [Hold Tap](https://zmk.dev/docs/behaviors/hold-tap#hold-tap) |
+| 🔁 | [Key Repeat](https://zmk.dev/docs/behaviors/key-repeat) |
+
+Key modifiers Description
+
+![Key Map](./.github/images/key-map.png)
+
+### Layout
+
+![Base Layer](./.github/images/0-layer.png)
+
+![Dev Layer](./.github/images/1-layer.png)
+
+![Actions/Number Layer](./.github/images/2-layer.png)
+
+![Settings](./.github/images/3-layer.png)
+
+⇧ [Back to menu](#menu)
+
+---
+
+## About
+
+### Built With
+
+- [VS Code](https://code.visualstudio.com/) - Code editing redefined.
+- [corne-zmk-config](https://github.com/AYM1607/corne-zmk-config) - Colemak DHm layout
+- [ZMK Docs](https://zmk.dev/docs) - Modern, open source keyboard firmware
+- [Keymap Editor](https://nickcoutsos.github.io/keymap-editor) - GUI ZMK Keymap Editor
+- [Colemak Mods](https://colemakmods.github.io/mod-dh/keyboards.html#matrix-keyboards) - Colemak-DH for a non-traditional, ergonomic keyboard
+
+### Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [swept-zmk-config](https://github.com/deinsoftware/swept-zmk-config/tags) on GitHub.
+
+### Authors
+
+- **Camilo Martinez** [[Equiman](http://github.com/equiman)]
+
+See also the list of [contributors](https://github.com/deinsoftware/swept-zmk-config/contributors) who participated in this project.
+
+### Sponsors
+
+If this project helps you, consider buying me a cup of coffee.
+
+[![paypal](https://img.shields.io/badge/-PayPal-gray?style=flat&labelColor=00457C&logo=paypal&logoColor=white&link=https://paypal.me/equiman/3)](https://paypal.me/equiman/3)
+[![ko-fi](https://img.shields.io/badge/-Ko–Fi-gray?style=flat&labelColor=fd444a&logo=ko-fi&logoColor=white&link=https://ko-fi.com/equiman)](https://ko-fi.com/equiman)
+
+### License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
+
+⇧ [Back to menu](#menu)