From 1dcdf19aecbffcdad7b0ead6d0135f30d24a6177 Mon Sep 17 00:00:00 2001
From: Mateusz Walkowiak <52051360+HyperDX@users.noreply.github.com>
Date: Fri, 2 Jun 2023 12:10:27 +0200
Subject: [PATCH] Create simple README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dc91ad8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# TEF6686_ESP32
+Advanced Arduino based firmware for TEF6686 tuner with ESP32 board
+
+More information: https://www.pe5pvb.nl/tef6686/
+
+## Instalation
+**Recommended method:** You can download already compiled software and upload it using prepared script from release page. Instructions are included in the archive.
+
+**Alternative method:** You can download source code from release page or using git. Then compile and upload it using for example Arduino IDE. **Important** you need to fill your User_Setup.h file (probably located in Arduino/libraries/TFT_eSPI folder) with these values:
+```
+#define ILI9341_DRIVER
+#define TFT_CS          5
+#define TFT_DC          17
+#define TFT_RST         16
+#define LOAD_GLCD
+#define LOAD_FONT2
+#define LOAD_FONT4
+#define LOAD_FONT6
+#define LOAD_FONT7
+#define LOAD_FONT8
+#define LOAD_GFXFF
+#define SMOOTH_FONT
+#define SPI_FREQUENCY   10000000
+```
+**ALL OTHER SETTINGS SHOULD BE REMARKED!**
+  
+
+## License
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.