From f398689c2907fdeaed6ce4c8e83171b30024fdf5 Mon Sep 17 00:00:00 2001
From: ItzAdel <gdquasar@bk.ru>
Date: Fri, 7 Jan 2022 19:35:44 +0400
Subject: [PATCH] README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f6cb43
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Angel Wings Keyboard (by [@ItzAdel](https://github.com/ItzAdel) and [@nm17](https://github.com/nm17))
+
+AWF is a ergo-split keyboard with 46 keys, originally designed for a school project.
+
+![Photo 1](https://github.com/ItzAdel/AngelWings-keyboard/blob/main/photos/awf%20(1).JPG)
+![Photo 2](https://github.com/ItzAdel/AngelWings-keyboard/blob/main/photos/awf%20(2).JPG)
+![Photo 3](https://github.com/ItzAdel/AngelWings-keyboard/blob/main/photos/awf%20(3).JPG)
+![Photo 4](https://github.com/ItzAdel/AngelWings-keyboard/blob/main/photos/awf%20(4).JPG)
+![Photo 5](https://github.com/ItzAdel/AngelWings-keyboard/blob/main/photos/awf%20(5).JPG)
+
+https://github.com/ItzAdel/AWF-firmware
+
+### How to compile firmware?
+
+1) First you need to download QMK MSYS and enter the command in it:
+```
+qmk setup
+```
+2) After we installed QMK you need to create a folder called "angelwings" in the path:
+```
+"c:/users/user/qmk_firmware/keyboards"
+```
+and unpack all firmware files into the folder "angelwings".
+
+3) The last step is compilation. Enter into QMK MSYS command:
+```
+qmk compile -kb angelwings -km default
+```
+or if you want VIA port:
+```
+qmk compile -kb angelwings -km via
+```
+4) If your firmware compiled - then let's have fun!
+
+### Check out @tfk004 on Telegram. https://t.me/tfk004