diff --git a/README.md b/README.md index 6adbeb5..c4fbb64 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,20 @@ A GUI for ESP8266 flash tool esptool-ck with basic features, geared towards being a production flashing tool. +esptool-gui screenshot + +## Installing + +You can download prebuilt binaries from the [releases section](https://github.com/Rodmg/esptool-gui/releases). + +## Building + +### OSX + +1. You should have Qt5 and QtCreator developer tools installed in your system (https://www.qt.io/developers/). tested with Qt 5.6.0 and Qt Creator 4.0.0. +2. Clone this repo and open ``esptool-gui.pro`` with Qt Creator, build from there. +3. For deploying the application, you should include the Qt libraries in te app bundle, you can use the mac deployment tool, more info here: http://doc.qt.io/qt-5/osx-deployment.html + +### Windows and Linux + +I haven't tested this in Windows and Linux, however building should be more or less straight forward. The only special build step that should change is the part where the [esptool-ck binary](https://github.com/igrr/esptool-ck/releases) is bundled, you should bundle the correct version for your operating system. You may also need to change the path in the code. \ No newline at end of file diff --git a/esptool-gui-screenshot.png b/esptool-gui-screenshot.png new file mode 100644 index 0000000..95a4928 Binary files /dev/null and b/esptool-gui-screenshot.png differ diff --git a/esptool-gui.pro.user b/esptool-gui.pro.user index b309062..adb3353 100644 --- a/esptool-gui.pro.user +++ b/esptool-gui.pro.user @@ -1,6 +1,6 @@ - + EnvironmentId