# Welcome to Hell.

## Installation instructions

No need to clone this repo manually. You'll just need to install the Rust toolchain.

```bash
# All OSes
cargo install --git https://git.zumepro.cz/michal.prochazka/tulflash
```

> [!NOTE]
> For macOS/Linux users: remember to add `$HOME/.cargo/bin` to your `$PATH` if you have not done so already!

## Running the example program

To compile the example program using tulflash, you will need to install SDCC.

```bash
# Generate the example program (only needed to run once):
tulflash example

# Compile, flash and monitor the example program:
tulflash run example.c

# note: `tulflash run example.c` is the same thing as `mkdir "tulflash/" && tulflash write --cmd "sdcc example.c" --cmd-path "tulflash/" --monitor example.ihx`
```

If the flash fails, try to add `--slow` before `run` (should not be needed though).

## Manually flashing Intel HEX binaries

If you use an external toolchain (such as MCU8051IDE with SDCC) and only want to use this program just for flashing the generated HEX file, just run the following:

```bash
# All OSes, automatically detects the correct serial port
tulflash write <path-to-hex>
```

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).