Update and move readmes

The READMEs that go to crates.io need to be in the crate dir

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 target
 Cargo.lock
+.vscode

README.md

@@ -8,7 +8,7 @@
    <h3 align="center">rp-hal</h3>
 
   <p align="center">
-    A Rust HAL impl for the RP family of microcontrollers from the Raspberry Pi Foundation
+    A Rust HAL and board support packages for the RP family of microcontrollers from the Raspberry Pi Foundation
     <br />
     <a href="https://github.com/rp-rs/rp-hal"><strong>Explore the docs »</strong></a>
     <br />
@@ -27,14 +27,7 @@
 <details open="open">
   <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
   <ol>
-   <li>
+    <li><a href="#packages">Packages</a></li>
-      <a href="#getting-started">Getting Started</a>
-      <ul>
-        <li><a href="#prerequisites">Prerequisites</a></li>
-        <li><a href="#installation">Installation</a></li>
-      </ul>
-    </li>
-    <li><a href="#usage">Usage</a></li>
     <li><a href="#roadmap">Roadmap</a></li>
     <li><a href="#contributing">Contributing</a></li>
     <li><a href="#license">License</a></li>
@@ -44,61 +37,21 @@
 </details>
 
 <!-- GETTING STARTED -->
-## Getting Started
+## Packages
 
-To get a local copy up and running follow these simple steps.
+- [rp2040-hal](https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal)
+- Board Support Packages:
+  - [Adafruit Macropad](https://github.com/rp-rs/rp-hal/tree/main/boards/adafruit_macropad)
+  - [Adafruit Feather RP2040](https://github.com/rp-rs/rp-hal/tree/main/boards/feather_rp2040)
+  - [Raspberry Pi Pico](https://github.com/rp-rs/rp-hal/tree/main/boards/pico)
+  - [Pimoroni Pico Explorer](https://github.com/rp-rs/rp-hal/tree/main/boards/pico_explorer)
+  - [Pimoroni Pico Lipo 16mb](https://github.com/rp-rs/rp-hal/tree/main/boards/pico_lipo_16mb)
 
-### Prerequisites
-
-* A [Rust](https://www.rust-lang.org/tools/install) toolchain
-
-### Installation
-
-1. Clone the repo or use the crate
-
-   ```sh
-   git clone https://github.com/rp-rs/rp-hal
-   ```
-
-   or
-
-   ```sh
-   cargo install rpXXXX-hal
-   ```
-
-<!-- USAGE EXAMPLES -->
-## Usage
-
-Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
-
-For more examples, please refer to the [Documentation](https://github.com/rp-rs/rp-hal)
-
-### Run examples
-
-#### UF2
-
-For boards with uf2 flashloaders like the raspberry pi pico. Install [`elf2uf2-rs`](https://github.com/JoNil/elf2uf2-rs):
-
-```sh
-cargo install elf2uf2-rs
-```
-
-Make sure .cargo/config contains the following (it should by default):
-
-```toml
-runner = "elf2uf2-rs -d"
-```
-
-**IMPORTANT: Make sure you've put your device into bootloader mode and the drive is showing as mounted before executing the next command.**
-
-```sh
-cargo run --example pico_pwm_blink # Run `cargo run --example` for more examples
-```
 
 <!-- ROADMAP -->
 ## Roadmap
 
-NOTE This HAL is under active development. As such, it is likely to remain volatile until a 1.0.0 release.
+NOTE These packages are under active development. As such, it is likely to remain volatile until a 1.0.0 release.
 
 See the [open issues](https://github.com/rp-rs/rp-hal/issues) for a list of proposed features (and known issues).
 
@@ -127,7 +80,7 @@ Distributed under the MIT OR Apache2.0 License. See `MIT` or `APACHE2.0` for mor
 ## Contact
 
 Project Link: [https://github.com/rp-rs/rp-hal/issues](https://github.com/rp-rs/rp-hal/issues)
-
+Matrix: [#rp-rs:matrix.org](https://matrix.to/#/#rp-rs:matrix.org)
 
 
 <!-- ACKNOWLEDGEMENTS -->

boards/adafruit_macropad/Cargo.toml

@@ -3,6 +3,7 @@ name = "adafruit_macropad"
 version = "0.1.0"
 authors = ["Andrea Nall <anall@andreanal.com>"]
 edition = "2018"
+homepage = "https://github.com/rp-rs/rp-hal/boards/adafruit_macropad"
 description = "Board Support Package for the Adafruit Macropad"
 license = "MIT OR Apache-2.0"
 

boards/adafruit_macropad/README.md

@@ -0,0 +1 @@
+Adafruit Macropad Board Support Crate

boards/pico_explorer/README.md

@@ -0,0 +1 @@
+Pimoroni Pico Explorer Board Support Crate

boards/pico_lipo_16mb/README.md

@@ -0,0 +1 @@
+Pimoroni Pico Lipo 16mb Board Support Crate

rp2040-hal/Cargo.toml

@@ -3,7 +3,7 @@ name = "rp2040-hal"
 version = "0.2.0"
 authors = ["evan <evanmolder@gmail.com>"]
 edition = "2018"
-homepage = "https://github.com/rp-rs/rp-hal/boards/pico-bsc"
+homepage = "https://github.com/rp-rs/rp-hal"
 description = "A Rust Embeded-HAL impl for the rp2040 microcontroller"
 license = "MIT OR Apache-2.0"
 

rp2040-hal/README.md

@@ -0,0 +1,136 @@
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/rp-rs/rp2040-hal">
+    <img src="https://www.svgrepo.com/show/281119/microchip.svg" alt="Logo" width="140" height="140">
+  </a>
+
+   <h3 align="center">rp-hal</h3>
+
+  <p align="center">
+    A Rust HAL impl for the RP family of microcontrollers from the Raspberry Pi Foundation
+    <br />
+    <a href="https://github.com/rp-rs/rp-hal"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/rp-rs/rp-hal">View Demo</a>
+    ·
+    <a href="https://github.com/rp-rs/rp-hal/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/rp-rs/rp-hal/issues">Request Feature</a>
+  </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
+  <ol>
+   <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgements">Acknowledgements</a></li>
+  </ol>
+</details>
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+To get a local copy up and running follow these simple steps.
+
+### Prerequisites
+
+* A [Rust](https://www.rust-lang.org/tools/install) toolchain
+
+### Installation
+
+1. Clone the repo or use the crate
+
+   ```sh
+   git clone https://github.com/rp-rs/rp-hal
+   ```
+
+   or
+
+   ```sh
+   cargo install rp2040-hal
+   ```
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+
+For more examples, please refer to the [Documentation](https://github.com/rp-rs/rp-hal)
+
+### Run examples
+
+#### UF2
+
+For boards with uf2 flashloaders like the raspberry pi pico. Install [`elf2uf2-rs`](https://github.com/JoNil/elf2uf2-rs):
+
+```sh
+cargo install elf2uf2-rs
+```
+
+Make sure .cargo/config contains the following (it should by default):
+
+```toml
+runner = "elf2uf2-rs -d"
+```
+
+**IMPORTANT: Make sure you've put your device into bootloader mode and the drive is showing as mounted before executing the next command.**
+
+```sh
+cargo run --example pico_pwm_blink # Run `cargo run --example` for more examples
+```
+
+<!-- ROADMAP -->
+## Roadmap
+
+NOTE This HAL is under active development. As such, it is likely to remain volatile until a 1.0.0 release.
+
+See the [open issues](https://github.com/rp-rs/rp-hal/issues) for a list of proposed features (and known issues).
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT OR Apache2.0 License. See `MIT` or `APACHE2.0` for more information.
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Project Link: [https://github.com/rp-rs/rp-hal/issues](https://github.com/rp-rs/rp-hal/issues)
+Matrix: [#rp-rs:matrix.org](https://matrix.to/#/#rp-rs:matrix.org)
+
+
+<!-- ACKNOWLEDGEMENTS -->
+## Acknowledgements
+
+* [Othneil Drew's README template](https://github.com/othneildrew)