Added README

This commit is contained in:
2025-09-18 13:28:05 +02:00
parent 8f6b7fbc1f
commit 3410a9a95b

28
README.md Normal file
View File

@@ -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 <path-to-hex>
# macOS
tulflash --port /dev/tty.usbserial-xxx write <path-to-hex>
# Wokňous
tulflash --port COMx write <path-to-hex>
```
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).