diff --git a/.gitignore b/.gitignore index 781f1c6..1a5e3e1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .idea/ target Cargo.lock +.vscode diff --git a/README.md b/README.md index 399a1fe..d31281e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

rp-hal

- 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
Explore the docs »
@@ -27,14 +27,7 @@

Table of Contents
    -
  1. - Getting Started - -
    2. -
  2. Usage
    3. +
  3. Packages
  4. Roadmap
  5. Contributing
  6. License
    7. @@ -44,61 +37,21 @@
-## 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 - -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 -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) diff --git a/boards/adafruit_macropad/Cargo.toml b/boards/adafruit_macropad/Cargo.toml index 73acefd..e170f7e 100644 --- a/boards/adafruit_macropad/Cargo.toml +++ b/boards/adafruit_macropad/Cargo.toml @@ -3,6 +3,7 @@ name = "adafruit_macropad" version = "0.1.0" authors = ["Andrea Nall "] 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" diff --git a/boards/adafruit_macropad/README.md b/boards/adafruit_macropad/README.md new file mode 100644 index 0000000..3da558f --- /dev/null +++ b/boards/adafruit_macropad/README.md @@ -0,0 +1 @@ +Adafruit Macropad Board Support Crate diff --git a/boards/pico_explorer/README.md b/boards/pico_explorer/README.md new file mode 100644 index 0000000..381b021 --- /dev/null +++ b/boards/pico_explorer/README.md @@ -0,0 +1 @@ +Pimoroni Pico Explorer Board Support Crate diff --git a/boards/pico_lipo_16mb/README.md b/boards/pico_lipo_16mb/README.md new file mode 100644 index 0000000..d7dacd1 --- /dev/null +++ b/boards/pico_lipo_16mb/README.md @@ -0,0 +1 @@ +Pimoroni Pico Lipo 16mb Board Support Crate \ No newline at end of file diff --git a/rp2040-hal/Cargo.toml b/rp2040-hal/Cargo.toml index 773f47f..0a93c2a 100644 --- a/rp2040-hal/Cargo.toml +++ b/rp2040-hal/Cargo.toml @@ -3,7 +3,7 @@ name = "rp2040-hal" version = "0.2.0" authors = ["evan "] 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" diff --git a/rp2040-hal/README.md b/rp2040-hal/README.md new file mode 100644 index 0000000..b5d1a0b --- /dev/null +++ b/rp2040-hal/README.md @@ -0,0 +1,136 @@ + +
+

+ + Logo + + +

rp-hal

+ +

+ A Rust HAL impl for the RP family of microcontrollers from the Raspberry Pi Foundation +
+ Explore the docs » +
+
+ View Demo + · + Report Bug + · + Request Feature +

+

+ + + + +
+

Table of Contents

 +
    +
  1. + Getting Started + +
    2. +
  2. Usage
    3. +
  3. Roadmap
    4. +
  4. Contributing
    5. +
  5. License
    6. +
  6. Contact
    7. +
  7. Acknowledgements
    8. +
+
+ + +## 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 + +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 + +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 + +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 + +Distributed under the MIT OR Apache2.0 License. See `MIT` or `APACHE2.0` for more information. + + + + +## 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 + +* [Othneil Drew's README template](https://github.com/othneildrew)