summaryrefslogtreecommitdiff
path: root/keyboards/handwired/angel/readme.md
diff options
context:
space:
mode:
authorjames sa <188772+jamessa@users.noreply.github.com>2021-01-30 11:24:42 +0800
committerGitHub <noreply@github.com>2021-01-29 19:24:42 -0800
commit53b35052eefc8a341cbc68d3d9aba52dfbf59f35 (patch)
treea68821ef895b45de1e41a0930542726b8d75303e /keyboards/handwired/angel/readme.md
parent5691f1341dcb48d7d043bfd6f8663b414aaf427d (diff)
[Keyboard] A symmetric stagger keyboard: Angel (#11501)
* New symmetric stagger keyboard: Angel * mac layout * layout simplify * Update keyboards/angel/info.json Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/angel/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/angel/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/angel/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/angel/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * tab lang switch * move to handwired and fix build instructions. Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/handwired/angel/readme.md')
-rw-r--r--keyboards/handwired/angel/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/handwired/angel/readme.md b/keyboards/handwired/angel/readme.md
new file mode 100644
index 0000000000..d3b2ddd643
--- /dev/null
+++ b/keyboards/handwired/angel/readme.md
@@ -0,0 +1,19 @@
+# Angel
+
+![Angel](https://raw.githubusercontent.com/jamessa/Angel/master/attachments/handwire.jpeg)
+
+Angel is a minimalist symmetrical stagger keyboard with thumb position in mind. Layout and hand wire guide is on [Github](https://github.com/jamessa/Angel).
+
+* Keyboard Maintainer: [James Sa](https://github.com/jamessa)
+* Hardware Supported: Hand wired
+* Hardware Availability: You can follow the build guide here. https://github.com/jamessa/Angel
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/angel:default
+
+Flashing example for this keyboard:
+
+ make handwired/angel:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools), the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide), and the [hand-wiring guide](https://docs.qmk.fm/#/hand_wire) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).