Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rodmg committed Aug 21, 2016
1 parent 8692338 commit e6d7ca9
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,20 @@

A GUI for ESP8266 flash tool esptool-ck with basic features, geared towards being a production flashing tool.

<img src="esptool-gui-screenshot.png?raw=true" alt="esptool-gui screenshot" width="500px">

## 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.
Binary file added esptool-gui-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion esptool-gui.pro.user
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE QtCreatorProject>
<!-- Written by QtCreator 4.0.0, 2016-06-28T00:25:43. -->
<!-- Written by QtCreator 4.0.0, 2016-08-21T00:24:45. -->
<qtcreator>
<data>
<variable>EnvironmentId</variable>
Expand Down

0 comments on commit e6d7ca9

Please sign in to comment.