diff --git a/README.md b/README.md index 9093fdc..64db7d1 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,20 @@ ## 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 # 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 @@ -18,7 +23,7 @@ tulflash example # Compile, flash and monitor the example program: 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).