From 0846d2ecca7560650549c123ad8a24c202f0cd62 Mon Sep 17 00:00:00 2001 From: Jan Niehusmann Date: Sat, 18 Feb 2023 14:01:01 +0000 Subject: [PATCH] Rename directory of pimoroni_badger2040 crate The directory name should match the crate name. --- Cargo.toml | 2 +- README.md | 4 ++-- .../.gitignore | 0 .../CHANGELOG.md | 0 .../Cargo.toml | 2 +- .../README.md | 10 +++++----- .../examples/badger_blinky.rs | 0 .../src/lib.rs | 0 8 files changed, 9 insertions(+), 9 deletions(-) rename boards/{pimoroni-badger2040 => pimoroni_badger2040}/.gitignore (100%) rename boards/{pimoroni-badger2040 => pimoroni_badger2040}/CHANGELOG.md (100%) rename boards/{pimoroni-badger2040 => pimoroni_badger2040}/Cargo.toml (98%) rename boards/{pimoroni-badger2040 => pimoroni_badger2040}/README.md (91%) rename boards/{pimoroni-badger2040 => pimoroni_badger2040}/examples/badger_blinky.rs (100%) rename boards/{pimoroni-badger2040 => pimoroni_badger2040}/src/lib.rs (100%) diff --git a/Cargo.toml b/Cargo.toml index 7aead35..0ba71d1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ members = [ "boards/adafruit-qt-py-rp2040", "boards/adafruit-trinkey-qt2040", "boards/arduino_nano_connect", - "boards/pimoroni-badger2040", + "boards/pimoroni_badger2040", "boards/pimoroni-pico-explorer", "boards/pimoroni-pico-lipo-16mb", "boards/pimoroni-plasma-2040", diff --git a/README.md b/README.md index 2ccc6cf..82d0fcd 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,7 @@ RP2040 chip according to how it is connected up on the Trinkey. [Adafruit-Trinkey-QT2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/adafruit-trinkey-qt2040 [adafruit trinkey qt2040]: https://www.adafruit.com/product/5056 -### [pimoroni-badger2040] - Board Support for the [Pimoroni Badger2040] +### [pimoroni_badger2040] - Board Support for the [Pimoroni Badger2040] You should include this crate if you are writing code that you want to run on a [Pimoroni Badger2040] - a conference-style badge built around an e-paper @@ -176,7 +176,7 @@ This crate includes the [rp2040-hal], but also configures each pin of the RP2040 chip according to how it is connected up on the Badger2040. [Pimoroni Badger2040]: https://shop.pimoroni.com/products/badger-2040 -[pimoroni-badger2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/pimoroni-badger2040 +[pimoroni_badger2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/pimoroni_badger2040 ### [pimoroni-pico-explorer] - Board Support for the [Pimoroni Pico Explorer] diff --git a/boards/pimoroni-badger2040/.gitignore b/boards/pimoroni_badger2040/.gitignore similarity index 100% rename from boards/pimoroni-badger2040/.gitignore rename to boards/pimoroni_badger2040/.gitignore diff --git a/boards/pimoroni-badger2040/CHANGELOG.md b/boards/pimoroni_badger2040/CHANGELOG.md similarity index 100% rename from boards/pimoroni-badger2040/CHANGELOG.md rename to boards/pimoroni_badger2040/CHANGELOG.md diff --git a/boards/pimoroni-badger2040/Cargo.toml b/boards/pimoroni_badger2040/Cargo.toml similarity index 98% rename from boards/pimoroni-badger2040/Cargo.toml rename to boards/pimoroni_badger2040/Cargo.toml index a3907c2..e2de88a 100644 --- a/boards/pimoroni-badger2040/Cargo.toml +++ b/boards/pimoroni_badger2040/Cargo.toml @@ -3,7 +3,7 @@ name = "pimoroni_badger2040" version = "0.4.0" authors = ["9names", "The rp-rs Developers"] edition = "2018" -homepage = "https://github.com/rp-rs/rp-hal-boards/tree/main/boards/pimoroni-badger2040" +homepage = "https://github.com/rp-rs/rp-hal-boards/tree/main/boards/pimoroni_badger2040" description = "Board Support Package for the Pimoroni Badger2040" license = "MIT OR Apache-2.0" repository = "https://github.com/rp-rs/rp-hal-boards.git" diff --git a/boards/pimoroni-badger2040/README.md b/boards/pimoroni_badger2040/README.md similarity index 91% rename from boards/pimoroni-badger2040/README.md rename to boards/pimoroni_badger2040/README.md index 072ae3e..20e5475 100644 --- a/boards/pimoroni-badger2040/README.md +++ b/boards/pimoroni_badger2040/README.md @@ -1,4 +1,4 @@ -# [pimoroni-badger2040] - Board Support for the [Pimoroni Badger2040] +# [pimoroni_badger2040] - Board Support for the [Pimoroni Badger2040] You should include this crate if you are writing code that you want to run on a [Pimoroni Badger2040] - a conference-style badge built around an e-paper @@ -8,7 +8,7 @@ This crate includes the [rp2040-hal], but also configures each pin of the RP2040 chip according to how it is connected up on the Badger2040. [Pimoroni Badger2040]: https://shop.pimoroni.com/products/badger-2040/ -[pimoroni-badger2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/pimoroni-badger2040 +[pimoroni_badger2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/pimoroni_badger2040 [rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal [Raspberry Silicon RP2040]: https://www.raspberrypi.org/products/rp2040/ @@ -17,7 +17,7 @@ RP2040 chip according to how it is connected up on the Badger2040. To use this crate, your `Cargo.toml` file should contain: ```toml -pimoroni-badger2040 = "0.4.0" +pimoroni_badger2040 = "0.4.0" ``` In your program, you will need to call `pimoroni_badger2040::Board::take().unwrap()` to create @@ -31,7 +31,7 @@ devices and configure common clocks. See the [examples](./examples) folder for m To compile an example, clone the _rp-hal-boards_ repository and run: ```console -rp-hal-boards/boards/pimoroni-badger2040 $ cargo build --release --example +rp-hal-boards/boards/pimoroni_badger2040 $ cargo build --release --example ``` You will get an ELF file called @@ -45,7 +45,7 @@ USB drive exported by the RP2040 bootloader, simply boot your board into bootloader mode and run: ```console -rp-hal-boards/boards/pimoroni-badger2040 $ cargo run --release --example +rp-hal-boards/boards/pimoroni_badger2040 $ cargo run --release --example ``` If you get an error about not being able to find `elf2uf2-rs`, try: diff --git a/boards/pimoroni-badger2040/examples/badger_blinky.rs b/boards/pimoroni_badger2040/examples/badger_blinky.rs similarity index 100% rename from boards/pimoroni-badger2040/examples/badger_blinky.rs rename to boards/pimoroni_badger2040/examples/badger_blinky.rs diff --git a/boards/pimoroni-badger2040/src/lib.rs b/boards/pimoroni_badger2040/src/lib.rs similarity index 100% rename from boards/pimoroni-badger2040/src/lib.rs rename to boards/pimoroni_badger2040/src/lib.rs