~/Projects/esptool-js
git clone https://code.lsong.org/esptool-js
Commit
- Commit
- e944e59051f82d67c0a0ef5d2d76f0ac51796140
- Author
- Ivan Grokhotkov <[email protected]>
- Date
- 2021-06-17 14:08:07 +0200 +0200
- Diffstat
README.md | 19 ++++++++++++++++++-
extend readme
diff --git a/README.md b/README.md index 13b44e80ad488219b802f80fdbaf35575f5a88d9..18485299980c2e280a5a3b65767aa53fea474f8a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,26 @@ # Javascript implementation of esptool +This repository contains a Javascript implementation of [esptool](https://github.com/espressif/esptool), a serial flasher utility for Espressif chips. Unlike the Python-based esptool, `esptool-js` doesn't implement generation of binary images out of ELF files, and doesn't include companion tools similar to [espefuse.py](https://github.com/espressif/esptool/wiki/espefuse) and [espsecure.py](https://github.com/espressif/esptool/wiki/espsecure). + +`esptool-js` is based on [Web Serial API](https://wicg.github.io/serial/) and works in Google Chrome and Microsoft Edge, [version 89 or later](https://developer.mozilla.org/en-US/docs/Web/API/Serial#browser_compatibility). + +## Live demo + +Visit https://espressif.github.io/esptool-js/ to see this tool in action. + +## Testing it locally + ``` +npm install +# Javascript implementation of esptool npm install xterm +``` + +# Javascript implementation of esptool npm install crypto-js + +# Javascript implementation of esptool python2 -m SimpleHTTPServer 8008 -``` +# Javascript implementation of esptool Then browse http://localhost:8008