summaryrefslogtreecommitdiff
path: root/keyboards/s60-x/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/s60-x/readme.md')
-rw-r--r--keyboards/s60-x/readme.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/s60-x/readme.md b/keyboards/s60-x/readme.md
new file mode 100644
index 0000000000..34c48b0b7d
--- /dev/null
+++ b/keyboards/s60-x/readme.md
@@ -0,0 +1,32 @@
+S60-x keyboard firmware
+======================
+DIY compact keyboard by Massdrop. This is a port from TMK to QMK based on the [original S60-X Repo](https://github.com/jpec/s60x).
+
+## S60X Resources
+- [Massdrop page](https://www.massdrop.com/buy/sentraq-60-diy-keyboard-kit)
+
+## Quantum MK Firmware
+
+For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+
+## Building
+
+Download or clone the whole firmware and navigate to the keyboards/s60-x folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
+
+Depending on which keymap you would like to use, you will have to compile slightly differently.
+
+### Default
+
+To build with the default keymap, simply run `make`.
+
+### Other Keymaps
+
+Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
+
+To build the firmware binary hex file with a keymap just do `make` with `keymap` option like:
+
+```
+$ make keymap=[default|<name>]
+```
+
+Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` \ No newline at end of file