From 7cbb0f181c1be102295c5717f89e8b89cd4e76ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Sun, 8 Jan 2017 15:54:35 +0100 Subject: [PATCH] Add a few links to README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d5765f0..622892b 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,14 @@ [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/marcelstoer/nodemcu-pyflasher/blob/master/LICENSE) [![Github Releases](https://img.shields.io/github/downloads/marcelstoer/nodemcu-pyflasher/total.svg?style=flat)](https://github.com/marcelstoer/nodemcu-pyflasher/releases) -Self-contained NodeMCU flasher with GUI based on [esptool.py](https://github.com/espressif/esptool) and [wxPython](https://www.wxpython.org/). +Self-contained [NodeMCU](https://github.com/nodemcu/nodemcu-firmware) flasher with GUI based on [esptool.py](https://github.com/espressif/esptool) and [wxPython](https://www.wxpython.org/). ![Image of NodeMCU PyFlasher GUI](images/gui.png) ## Status Check the [releases section](https://github.com/marcelstoer/nodemcu-pyflasher/releases) for progress and downloadable binaries for your platform. Scan the [list of open issues](https://github.com/marcelstoer/nodemcu-pyflasher/issues) for bugs and pending features. + - Due to [pyinstaller/pyinstaller#2355](https://github.com/pyinstaller/pyinstaller/issues/2355) I can't provide an app bundle for macOS yet. The PyInstaller `.spec` file and the build script are ready, though. - Due to [esptool/issues/#155](https://github.com/espressif/esptool/issues/155) you'll see "debug" output from esptool.py when it attempts to reconnect to your device. @@ -23,7 +24,8 @@ This addresses an issue the NodeMCU community touched on several times in the pa [#1500 (comment)](https://github.com/nodemcu/nodemcu-firmware/pull/1500#issuecomment-247884981). I stated that based on my experience doing NodeMCU user support it should be a lot simpler to flash NodeMCU for Windows users. -- A number of flashing tools are available but only two are actively maintained: esptool-ck and esptool.py. Only one is endorsed by Espressif: esptool.py (they hired the developer(s)). + +- A number of flashing tools are available but only two are actively maintained: esptool-ck and esptool.py. Only one is endorsed by Espressif: [esptool.py](https://github.com/espressif/esptool) (they hired the developer(s)). - 70% of the users of my [nodemcu-build.com](https://nodemcu-build.com) service are on Windows. - BUT Windows doesn't come with Python installed - which is required for esptool.py. - BUT Windows users in general are more reluctant to use the CLI than Linux/Mac users - which is required for esptool.py. @@ -37,7 +39,7 @@ For quite a while I planned to write a self-contained GUI tool which would use e - Uses the cross-platform wxPython GUI framework. I also tried PyForms/PyQt4 but settled for wxPython. - Requires absolutely minimal user input. - The esptool.py "console" output is redirected to text control on the GUI. -- Uses PyInstaller to create self-contained executable for Windows and Mac. The packaged app can run standalone i.e. without installing itself, a Python interpreter or any modules. +- Uses [PyInstaller](https://github.com/pyinstaller/pyinstaller) to create self-contained executable for Windows and Mac. The packaged app can run standalone i.e. without installing itself, a Python interpreter or any modules. ## License [MIT](http://opensource.org/licenses/MIT) © Marcel Stör