diff options
| author | Ulf Lilleengen <[email protected]> | 2022-11-23 14:48:51 +0100 |
|---|---|---|
| committer | Ulf Lilleengen <[email protected]> | 2022-11-25 11:43:12 +0100 |
| commit | 89821846d77d85d940b87cfa4f62171bd532b27c (patch) | |
| tree | d14237e406262134e3a8b8d2bdc41961ed181ea5 /embassy-boot/README.md | |
| parent | 758f5d7ea29f1df14d5ef59c82e4b7f22545d775 (diff) | |
fix: add required metadata for embassy-boot
Diffstat (limited to 'embassy-boot/README.md')
| -rw-r--r-- | embassy-boot/README.md | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/embassy-boot/README.md b/embassy-boot/README.md deleted file mode 100644 index 414405377..000000000 --- a/embassy-boot/README.md +++ /dev/null | |||
| @@ -1,30 +0,0 @@ | |||
| 1 | # embassy-boot | ||
| 2 | |||
| 3 | An [Embassy](https://embassy.dev) project. | ||
| 4 | |||
| 5 | A lightweight bootloader supporting firmware updates in a power-fail-safe way, with trial boots and rollbacks. | ||
| 6 | |||
| 7 | The bootloader can be used either as a library or be flashed directly with the default configuration derived from linker scripts. | ||
| 8 | |||
| 9 | By design, the bootloader does not provide any network capabilities. Networking capabilities for fetching new firmware can be provided by the user application, using the bootloader as a library for updating the firmware, or by using the bootloader as a library and adding this capability yourself. | ||
| 10 | |||
| 11 | ## Hardware support | ||
| 12 | |||
| 13 | The bootloader supports different hardware in separate crates: | ||
| 14 | |||
| 15 | * `embassy-boot-nrf` - for the nRF microcontrollers. | ||
| 16 | * `embassy-boot-stm32` - for the STM32 microcontrollers. | ||
| 17 | |||
| 18 | ## Minimum supported Rust version (MSRV) | ||
| 19 | |||
| 20 | `embassy-boot` requires Rust nightly to compile as it relies on async traits for interacting with the flash peripherals. | ||
| 21 | |||
| 22 | ## License | ||
| 23 | |||
| 24 | This work is licensed under either of | ||
| 25 | |||
| 26 | - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or | ||
| 27 | <http://www.apache.org/licenses/LICENSE-2.0>) | ||
| 28 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>) | ||
| 29 | |||
| 30 | at your option. | ||
