From b452a6bcf6858893a85882614e2dcde5a3405748 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Thu, 11 Jan 2024 18:18:35 +0100 Subject: [PATCH] Centralize license and MSRV boilerplate into the repo readme. --- LICENSE-APACHE | 2 +- LICENSE-MIT | 2 +- README.md | 8 +++++++- cyw43-pio/README.md | 14 -------------- cyw43/README.md | 15 --------------- embassy-boot/boot/README.md | 15 --------------- embassy-boot/nrf/README.md | 15 --------------- embassy-boot/rp/README.md | 14 -------------- embassy-boot/stm32/README.md | 14 -------------- embassy-executor-macros/README.md | 10 ---------- embassy-futures/README.md | 15 --------------- embassy-hal-internal/README.md | 10 ---------- embassy-net-adin1110/README.md | 10 ---------- embassy-net-driver-channel/README.md | 10 ---------- embassy-net-driver/README.md | 10 ---------- embassy-net-enc28j60/README.md | 10 ---------- embassy-net-esp-hosted/README.md | 11 ----------- embassy-net-ppp/README.md | 10 ---------- embassy-net-tuntap/README.md | 10 ---------- embassy-net-wiznet/README.md | 11 ----------- embassy-net/README.md | 10 ---------- embassy-nrf/README.md | 15 --------------- embassy-rp/README.md | 14 -------------- embassy-sync/README.md | 14 -------------- embassy-usb-dfu/README.md | 14 -------------- embassy-usb-driver/README.md | 15 --------------- embassy-usb-logger/README.md | 14 -------------- embassy-usb/README.md | 16 ---------------- 28 files changed, 9 insertions(+), 319 deletions(-) diff --git a/LICENSE-APACHE b/LICENSE-APACHE index ea4fa15c9..8f7956e20 100644 --- a/LICENSE-APACHE +++ b/LICENSE-APACHE @@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work. same "printed page" as the copyright notice for easier identification within third-party archives. -Copyright 2019-2022 Embassy project contributors +Copyright (c) Embassy project contributors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/LICENSE-MIT b/LICENSE-MIT index 87c052836..1fe5730a4 100644 --- a/LICENSE-MIT +++ b/LICENSE-MIT @@ -1,4 +1,4 @@ -Copyright (c) 2019-2022 Embassy project contributors +Copyright (c) Embassy project contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated diff --git a/README.md b/README.md index d2a24dfcc..24347a43f 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ EMBedded ASYnc! :) ## License -This work is licensed under either of +Embassy is licensed under either of - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or ) @@ -153,5 +153,11 @@ This work is licensed under either of at your option. +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + [1]: https://github.com/embassy-rs/embassy/wiki/Getting-Started [2]: https://github.com/embassy-rs/embassy/wiki/Running-the-Examples diff --git a/cyw43-pio/README.md b/cyw43-pio/README.md index 2b22db360..4a2b2aa4b 100644 --- a/cyw43-pio/README.md +++ b/cyw43-pio/README.md @@ -1,17 +1,3 @@ # cyw43-pio RP2040 PIO driver for the nonstandard half-duplex SPI used in the Pico W. The PIO driver offloads SPI communication with the WiFi chip and improves throughput. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/cyw43/README.md b/cyw43/README.md index 2c24c7d36..dabdf0471 100644 --- a/cyw43/README.md +++ b/cyw43/README.md @@ -44,18 +44,3 @@ This example implements a TCP echo server on port 1234. You can try connecting t nc 192.168.0.250 1234 ``` Send it some data, you should see it echoed back and printed in the firmware's logs. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-boot/boot/README.md b/embassy-boot/boot/README.md index 3fc81f24b..3c2d45e96 100644 --- a/embassy-boot/boot/README.md +++ b/embassy-boot/boot/README.md @@ -33,18 +33,3 @@ The bootloader supports different hardware in separate crates: * `embassy-boot-nrf` - for the nRF microcontrollers. * `embassy-boot-rp` - for the RP2040 microcontrollers. * `embassy-boot-stm32` - for the STM32 microcontrollers. - - -## Minimum supported Rust version (MSRV) - -`embassy-boot` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-boot/nrf/README.md b/embassy-boot/nrf/README.md index fe581823d..9dc5b0eb9 100644 --- a/embassy-boot/nrf/README.md +++ b/embassy-boot/nrf/README.md @@ -9,18 +9,3 @@ An adaptation of `embassy-boot` for nRF. * Load applications with or without the softdevice. * Configure bootloader partitions based on linker script. * Using watchdog timer to detect application failure. - - -## Minimum supported Rust version (MSRV) - -`embassy-boot-nrf` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-boot/rp/README.md b/embassy-boot/rp/README.md index 315d655e3..b664145a9 100644 --- a/embassy-boot/rp/README.md +++ b/embassy-boot/rp/README.md @@ -10,17 +10,3 @@ NOTE: The applications using this bootloader should not link with the `link-rp.x * Configure bootloader partitions based on linker script. * Load applications from active partition. - -## Minimum supported Rust version (MSRV) - -`embassy-boot-rp` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-boot/stm32/README.md b/embassy-boot/stm32/README.md index b4d7ba5a4..f6dadc8e7 100644 --- a/embassy-boot/stm32/README.md +++ b/embassy-boot/stm32/README.md @@ -8,17 +8,3 @@ An adaptation of `embassy-boot` for STM32. * Configure bootloader partitions based on linker script. * Load applications from active partition. - -## Minimum supported Rust version (MSRV) - -`embassy-boot-stm32` is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-executor-macros/README.md b/embassy-executor-macros/README.md index a959c85d5..3a8d49aa1 100644 --- a/embassy-executor-macros/README.md +++ b/embassy-executor-macros/README.md @@ -3,13 +3,3 @@ An [Embassy](https://embassy.dev) project. NOTE: Do not use this crate directly. The macros are re-exported by `embassy-executor`. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-futures/README.md b/embassy-futures/README.md index 7add22c7b..b28a8431a 100644 --- a/embassy-futures/README.md +++ b/embassy-futures/README.md @@ -11,18 +11,3 @@ ideal for embedded systems. ## Interoperability Futures from this crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-hal-internal/README.md b/embassy-hal-internal/README.md index 6b060d1c0..1adce5b33 100644 --- a/embassy-hal-internal/README.md +++ b/embassy-hal-internal/README.md @@ -4,13 +4,3 @@ An [Embassy](https://embassy.dev) project. Internal implementation details for Embassy HALs. DO NOT USE DIRECTLY. Embassy HALs (`embassy-nrf`, `embassy-stm32`, `embassy-rp`) already reexport everything you need to use them effectively. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-net-adin1110/README.md b/embassy-net-adin1110/README.md index 8ea10b714..39a38960d 100644 --- a/embassy-net-adin1110/README.md +++ b/embassy-net-adin1110/README.md @@ -76,13 +76,3 @@ Summary: Size/request: 289 B Size/sec: 51.11 KiB ``` - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-driver-channel/README.md b/embassy-net-driver-channel/README.md index 90a216388..1955624d1 100644 --- a/embassy-net-driver-channel/README.md +++ b/embassy-net-driver-channel/README.md @@ -84,13 +84,3 @@ These `embassy-net` drivers are implemented using this crate. You can look at th ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-driver/README.md b/embassy-net-driver/README.md index 6a757380d..24fcaafc4 100644 --- a/embassy-net-driver/README.md +++ b/embassy-net-driver/README.md @@ -16,13 +16,3 @@ packet queues for RX and TX. ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-enc28j60/README.md b/embassy-net-enc28j60/README.md index 39011ca13..5c663b52e 100644 --- a/embassy-net-enc28j60/README.md +++ b/embassy-net-enc28j60/README.md @@ -7,13 +7,3 @@ Based on [@japaric](https://github.com/japaric)'s [`enc28j60`](https://github.co ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-esp-hosted/README.md b/embassy-net-esp-hosted/README.md index 3c9cc4c9e..f6c216835 100644 --- a/embassy-net-esp-hosted/README.md +++ b/embassy-net-esp-hosted/README.md @@ -14,14 +14,3 @@ See [`examples`](https://github.com/embassy-rs/embassy/tree/main/examples/nrf528 This crate can run on any executor. It supports any SPI driver implementing [`embedded-hal-async`](https://crates.io/crates/embedded-hal-async). - - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-ppp/README.md b/embassy-net-ppp/README.md index 58d67395a..0eb7cee87 100644 --- a/embassy-net-ppp/README.md +++ b/embassy-net-ppp/README.md @@ -7,13 +7,3 @@ This crate can run on any executor. It supports any serial port implementing [`embedded-io-async`](https://crates.io/crates/embedded-io-async). - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-tuntap/README.md b/embassy-net-tuntap/README.md index c5d9e746c..60a4a1bd9 100644 --- a/embassy-net-tuntap/README.md +++ b/embassy-net-tuntap/README.md @@ -5,13 +5,3 @@ ## Interoperability This crate can run on any executor. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net-wiznet/README.md b/embassy-net-wiznet/README.md index b8e4bdc8e..786aab18d 100644 --- a/embassy-net-wiznet/README.md +++ b/embassy-net-wiznet/README.md @@ -14,14 +14,3 @@ See [`examples`](https://github.com/embassy-rs/embassy/tree/main/examples/rp) di This crate can run on any executor. It supports any SPI driver implementing [`embedded-hal-async`](https://crates.io/crates/embedded-hal-async). - - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-net/README.md b/embassy-net/README.md index 52d048e6a..94aa6f550 100644 --- a/embassy-net/README.md +++ b/embassy-net/README.md @@ -51,13 +51,3 @@ This crate can run on any executor. [`embassy-time`](https://crates.io/crates/embassy-time) is used for timekeeping and timeouts. You must link an `embassy-time` driver in your project to use this crate. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. diff --git a/embassy-nrf/README.md b/embassy-nrf/README.md index 39de3854b..5e2bd86de 100644 --- a/embassy-nrf/README.md +++ b/embassy-nrf/README.md @@ -43,18 +43,3 @@ as the methods without the suffix will be allocating a statically sized buffer ( Note that the methods that read data like [`read`](spim::Spim::read) and [`transfer_in_place`](spim::Spim::transfer_in_place) do not have the corresponding `_from_ram` variants as mutable slices always reside in RAM. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-rp/README.md b/embassy-rp/README.md index cd79fe501..1d14eca52 100644 --- a/embassy-rp/README.md +++ b/embassy-rp/README.md @@ -7,17 +7,3 @@ for many peripherals. The benefit of using the async APIs is that the HAL takes complete operations in low power mod and handling interrupts, so that applications can focus on more important matters. NOTE: The Embassy HALs can be used both for non-async and async operations. For async, you can choose which runtime you want to use. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-sync/README.md b/embassy-sync/README.md index 55618f72d..c2e13799e 100644 --- a/embassy-sync/README.md +++ b/embassy-sync/README.md @@ -17,17 +17,3 @@ Synchronization primitives and data structures with async support: ## Interoperability Futures from this crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-usb-dfu/README.md b/embassy-usb-dfu/README.md index d8bc19bfd..bdd5b033a 100644 --- a/embassy-usb-dfu/README.md +++ b/embassy-usb-dfu/README.md @@ -4,17 +4,3 @@ An implementation of the USB DFU 1.1 protocol using embassy-boot. It has 2 compo * DFU protocol mode, enabled by the `dfu` feature. This mode corresponds to the transfer phase DFU protocol described by the USB IF. It supports DFU_DNLOAD requests if marked by the user, and will automatically reset the chip once a DFU transaction has been completed. It also responds to DFU_GETSTATUS, DFU_GETSTATE, DFU_ABORT, and DFU_CLRSTATUS with no user intervention. * DFU runtime mode, enabled by the `application feature`. This mode allows users to expose a DFU interface on their USB device, informing the host of the capability to DFU over USB, and allowing the host to reset the device into its bootloader to complete a DFU operation. Supports DFU_GETSTATUS and DFU_DETACH. When detach/reset is seen by the device as described by the standard, will write a new DFU magic number into the bootloader state in flash, and reset the system. - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-usb-driver/README.md b/embassy-usb-driver/README.md index 93aef7596..7628a6937 100644 --- a/embassy-usb-driver/README.md +++ b/embassy-usb-driver/README.md @@ -15,18 +15,3 @@ instead of this one. ## Interoperability This crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -This crate requires nightly Rust, due to using "async fn in trait" support. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - diff --git a/embassy-usb-logger/README.md b/embassy-usb-logger/README.md index 6cb18e87d..81b0dcd0e 100644 --- a/embassy-usb-logger/README.md +++ b/embassy-usb-logger/README.md @@ -13,17 +13,3 @@ async fn logger_task(driver: Driver<'static, USB>) { embassy_usb_logger::run!(1024, log::LevelFilter::Info, driver); } ``` - -## Minimum supported Rust version (MSRV) - -Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. diff --git a/embassy-usb/README.md b/embassy-usb/README.md index a3d45b561..da656e8e9 100644 --- a/embassy-usb/README.md +++ b/embassy-usb/README.md @@ -23,22 +23,6 @@ with different values, compilation fails. Max amount of interfaces that can be created in one device. Default: 4. - ## Interoperability This crate can run on any executor. - -## Minimum supported Rust version (MSRV) - -This crate requires nightly Rust, due to using "async fn in trait" support. - -## License - -This work is licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or - ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. -