diff --git a/README.md b/README.md new file mode 100644 index 0000000..5716b9b --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Welcome to Hell. + +## Installation instructions + +No need to clone this repo manually. You'll just need to install the Rust toolchain. + +``` +# All OSes +cargo install --git https://git.zumepro.cz/michal.prochazka/tulflash +``` + +## Flashing Intel HEX binaries + +``` +# Linux +tulflash --port /dev/ttyUSBx write + +# macOS +tulflash --port /dev/tty.usbserial-xxx write + +# Wokňous +tulflash --port COMx write +``` + +If the flash fails, try to add `--slow` before the `--port` argument (should not be needed though). + +The tool also allows reading and erasing the chip, figure that out on your own if you need that (although `tulflash --help` might guide you if you ask it nicely). +