Initial Commit

Readme.md

@@ -0,0 +1,43 @@
+# cargo-dfu
+
+This crate provides a cargo subcommand to flash ELF binaries via dfu
+Most STM chips will probably work with this, although you might need to add the vid and pid to the vendor map
+
+## Installation
+
+You can install this utility with cargo:
+
+```bash
+cargo install cargo-dfu
+```
+
+## Usage
+
+You can use it like cargo build or cargo-flash with the option of giving the vid and pid:
+
+```bash
+cargo dfu <args> --vid <vid> --pid <pid>
+```
+
+### Examples
+
+#### flash the debug version of the current crate
+
+```bash
+cargo dfu 
+```
+
+#### specifying the vid and pid
+
+```bash
+cargo dfu --vid 0x483 --pid 0xdf11
+```
+
+## Add chip definitions
+feel free to open a PR to add chips to this
+
+## Roadmap
+- [ ] add chip to vendor map so one can optionally use --chip to specify the desired chip
+- [ ] add some more chips to the crate (like the gd32vf103)
+- [ ] make this crate multi-platform (PR to either the dfu crate to use rusb or the usbapi to add platform support)
+