diff --git a/README b/README.md similarity index 73% rename from README rename to README.md index ac096dc..6c00b3a 100644 --- a/README +++ b/README.md @@ -5,8 +5,18 @@ Python script which will talk to the STM32 bootloader to upload and download fir Original Version by: Ivan A-R +## Installation -Usage: ./stm32loader.py [-hqVewvr] [-l length] [-p port] [-b baud] [-a addr] [file.bin] +```bash +git clone git@github.com:jsnyder/stm32loader.git +cd stm32loader +pip install -r requirements.txt +``` + +## Usage + +```bash +./stm32loader.py [-hqVewvr] [-l length] [-p port] [-b baud] [-a addr] [file.bin] -h This help -q Quiet -V Verbose @@ -18,12 +28,12 @@ Usage: ./stm32loader.py [-hqVewvr] [-l length] [-p port] [-b baud] [-a addr] [fi -p port Serial port (default: /dev/tty.usbserial-ftCYPMYJ) -b baud Baud speed (default: 115200) -a addr Target address +``` - ./stm32loader.py -e -w -v example/main.bin +## Example - -Example: +```bash stm32loader.py -e -w -v somefile.bin - +``` This will pre-erase flash, write somefile.bin to the flash on the device, and then perform a verification after writing is finished. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8b2635b --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +pyserial>=3.1.1 \ No newline at end of file