michal.prochazka/tulflash
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Michal Procházka
2025-09-25 12:00:44 +02:00
parent 75664c433e
commit c9c31ebd23
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -2,15 +2,20 @@
## Installation instructions ## Installation instructions
No need to clone this repo manually. You'll just need to install the Rust toolchain and SDCC. No need to clone this repo manually. You'll just need to install the Rust toolchain.
```bash ```bash
# All OSes # All OSes
cargo install --git https://git.zumepro.cz/michal.prochazka/tulflash 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 ## Running the example program
To compile the example program using tulflash, you will need to install SDCC.
```bash ```bash
# Generate the example program (only needed to run once): # Generate the example program (only needed to run once):
tulflash example tulflash example
@@ -18,7 +23,7 @@ tulflash example
# Compile, flash and monitor the example program: # Compile, flash and monitor the example program:
tulflash run example.c: tulflash run example.c:
# note: `tulflash run example.c` is the thing as `mkdir "tulflash/" && tulflash write --cmd "sdcc example.c" --cmd-path "tulflash/" --monitor example.ihx` # 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). If the flash fails, try to add `--slow` before `run` (should not be needed though).