Merge pull request #101 from pros-rs/bump

docs: add required fields to manifests
vexide · Mar 6, 2024 · 3d86c15 · 3d86c15
2 parents c25d1a2 + dc11546
commit 3d86c15
Show file tree

Hide file tree

Showing 17 changed files with 132 additions and 13 deletions.
diff --git a/packages/pros-async/Cargo.toml b/packages/pros-async/Cargo.toml
@@ -2,6 +2,20 @@
 name = "pros-async"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "A simple async executor for pros-rs"
+keywords = ["PROS", "Robotics", "bindings", "async", "vex", "v5"]
+categories = [
+    "no-std",
+    "science::robotics",
+    "Asynchronous"
+]
+repository = "https://github.com/gavin-niederman/pros-rs"
+authors = [
+    "pros-rs",
+    "Gavin Niederman <gavinniederman@gmail.com>",
+    "doinkythederp <doinkythederp@icloud.com>",
+]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/packages/pros-async/README.md b/packages/pros-async/README.md
@@ -0,0 +1,6 @@
+# pros-async
+
+Tiny async runtime and robot traits for `pros-rs`.
+The async executor supports spawning tasks and blocking on futures.
+It has a reactor to improve the performance of some futures.
+FreeRTOS tasks can still be used, but it is recommended to use only async tasks for performance.
diff --git a/packages/pros-core/Cargo.toml b/packages/pros-core/Cargo.toml
@@ -2,6 +2,20 @@
 name = "pros-core"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "Core functionality for pros-rs"
+keywords = ["PROS", "Robotics", "bindings", "vex", "v5"]
+categories = [
+    "api-bindings",
+    "no-std",
+    "science::robotics",
+]
+repository = "https://github.com/gavin-niederman/pros-rs"
+authors = [
+    "pros-rs",
+    "Gavin Niederman <gavinniederman@gmail.com>",
+    "doinkythederp <doinkythederp@icloud.com>",
+]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/packages/pros-core/README.md b/packages/pros-core/README.md
@@ -0,0 +1,10 @@
+# pros-core
+Low level core functionality for [`pros-rs`](https://crates.io/crates/pros).
+The core crate is used in all other crates in the pros-rs ecosystem.
+Included in this crate:
+- Global allocator
+- Errno handling
+- Serial terminal printing
+- No-std `Instant`s
+- Synchronization primitives
+- FreeRTOS task management
diff --git a/packages/pros-core/src/lib.rs b/packages/pros-core/src/lib.rs
@@ -3,7 +3,6 @@
 //!
 //! Included in this crate:
 //! - Global allocator: [`pros_alloc`]
-//! - Competition state checking: [`competition`]
 //! - Errno handling: [`error`]
 //! - Serial terminal printing: [`io`]
 //! - No-std [`Instant`](time::Instant)s: [`time`]

diff --git a/packages/pros-devices/Cargo.toml b/packages/pros-devices/Cargo.toml
@@ -2,6 +2,20 @@
 name = "pros-devices"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "High level device for pros-rs"
+keywords = ["PROS", "Robotics", "bindings", "vex", "v5"]
+categories = [
+    "api-bindings",
+    "no-std",
+    "science::robotics",
+]
+repository = "https://github.com/gavin-niederman/pros-rs"
+authors = [
+    "pros-rs",
+    "Gavin Niederman <gavinniederman@gmail.com>",
+    "doinkythederp <doinkythederp@icloud.com>",
+]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/packages/pros-devices/README.md b/packages/pros-devices/README.md
@@ -0,0 +1,14 @@
+# pros-devices
+
+Functionality for accessing hardware connected to the V5 brain.
+
+## Overview
+
+The V5 brain features 21 RJ9 4p4c connector ports (known as "Smart ports") for communicating with newer V5 peripherals, as well as six 3-wire ports with log-to-digital conversion capability for compatibility with legacy Cortex devices. This module provides access to both smart devices and ADI devices.
+
+## Organization
+
+- `smart` contains abstractions and types for smart port connected ices.
+- `adi` contains abstractions for three wire ADI connected devices.
+- `battery` provides functions for getting information about the battery.
+- `controller` provides types for interacting with the V5 controller.
diff --git a/packages/pros-devices/src/lib.rs b/packages/pros-devices/src/lib.rs
@@ -1,15 +1,12 @@
-//! Devices
+//! # pros-devices
 //!
-//! This module provides functionality for accessing hardware and devices connected to the V5 brain.
+//! Functionality for accessing hardware connected to the V5 brain.
 //!
-//! # Overview
+//! ## Overview
 //!
-//! The V5 brain features 21 RJ9 4p4c connector ports (known as "Smart Ports") for communicating with
-//! newer V5 peripherals, as well as six 3-wire ports with analog-to-digital conversion capability for
-//! compatibility with legacy cortex devices. This module provides access for both smart devices and
-//! ADI devices.
+//! The V5 brain features 21 RJ9 4p4c connector ports (known as "Smart ports") for communicating with newer V5 peripherals, as well as six 3-wire ports with log-to-digital conversion capability for compatibility with legacy Cortex devices. This module provides access to both smart devices and ADI devices.
 //!
-//! # Organization
+//! ## Organization
 //!
 //! - [`smart`] contains abstractions and types for smart port connected devices.
 //! - [`adi`] contains abstractions for three wire ADI connected devices.

diff --git a/packages/pros-math/Cargo.toml b/packages/pros-math/Cargo.toml
@@ -2,6 +2,20 @@
 name = "pros-math"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "Commonly used mathematical formulas for pros-rs"
+keywords = ["PROS", "Robotics", "vex", "v5"]
+categories = [
+    "no-std",
+    "science::robotics",
+    "Mathematics",
+]
+repository = "https://github.com/gavin-niederman/pros-rs"
+authors = [
+    "pros-rs",
+    "Gavin Niederman <gavinniederman@gmail.com>",
+    "doinkythederp <doinkythederp@icloud.com>",
+]
 
 [dependencies]
 num = { version = "0.4.1", default-features = false }

diff --git a/packages/pros-math/README.md b/packages/pros-math/README.md
@@ -0,0 +1,3 @@
+# pros-math
+
+Common mathematical formulas and models implemented for [`pros-rs`](https://crates.io/crates/pros).
diff --git a/packages/pros-panic/Cargo.toml b/packages/pros-panic/Cargo.toml
@@ -2,6 +2,19 @@
 name = "pros-panic"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "Panic handler for pros-rs"
+keywords = ["PROS", "Robotics", "vex", "v5"]
+categories = [
+    "no-std",
+    "science::robotics",
+]
+repository = "https://github.com/gavin-niederman/pros-rs"
+authors = [
+    "pros-rs",
+    "Gavin Niederman <gavinniederman@gmail.com>",
+    "doinkythederp <doinkythederp@icloud.com>",
+]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/packages/pros-panic/README.md b/packages/pros-panic/README.md
@@ -0,0 +1,5 @@
+# pros-panic
+
+Panic handler implementation for [`pros-rs`](https://crates.io/crates/pros-rs).
+Supports printing a backtrace when running in the simulator.
+If the `display_panics` feature is enabled, it will also display the panic message on the V5 Brain display.
diff --git a/packages/pros-sync/Cargo.toml b/packages/pros-sync/Cargo.toml
@@ -2,6 +2,19 @@
 name = "pros-sync"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "`SyncRobot` trait and macro for pros-rs"
+keywords = ["PROS", "Robotics", "vex", "v5"]
+categories = [
+    "no-std",
+    "science::robotics",
+]
+repository = "https://github.com/gavin-niederman/pros-rs"
+authors = [
+    "pros-rs",
+    "Gavin Niederman <gavinniederman@gmail.com>",
+    "doinkythederp <doinkythederp@icloud.com>",
+]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/packages/pros-sync/README.md b/packages/pros-sync/README.md
@@ -0,0 +1,3 @@
+# pros-sync
+
+Synchronous robot code trait for [pros-rs](https://crates.io/crates/pros).
diff --git a/packages/pros-sys/Cargo.toml b/packages/pros-sys/Cargo.toml
@@ -3,7 +3,7 @@ name = "pros-sys"
 version = "0.7.0"
 edition = "2021"
 description = "EFI for the PROS rust bindings"
-keywords = ["PROS", "Robotics", "bindings"]
+keywords = ["PROS", "Robotics", "bindings", "vex", "v5"]
 categories = [
     "api-bindings",
     "development-tools::ffi",

diff --git a/packages/pros-sys/README.md b/packages/pros-sys/README.md
@@ -1,7 +1,7 @@
 # Pros-sys
 
- EFI for Rust PROS bindings, used in [pros-rs](https://crates.io/crates/pros)
+EFI for Rust PROS bindings, used in [pros-rs](https://crates.io/crates/pros)
 
 ## This project is still very early in development
 
- Make sure to check out the todo list [(TODO.md)](../TODO.md)
+Make sure to check out the todo list [(TODO.md)](../TODO.md)
diff --git a/packages/pros/Cargo.toml b/packages/pros/Cargo.toml
@@ -3,7 +3,7 @@ name = "pros"
 version = "0.8.0"
 edition = "2021"
 description = "Rust bindings for PROS"
-keywords = ["PROS", "Robotics", "bindings"]
+keywords = ["PROS", "Robotics", "bindings", "vex", "v5"]
 categories = ["os", "api-bindings", "no-std", "science::robotics"]
 license = "MIT"
 repository = "https://github.com/pros-rs/pros-rs"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# pros-math

		Common mathematical formulas and models implemented for [`pros-rs`](https://crates.io/crates/pros).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# pros-sync

		Synchronous robot code trait for [pros-rs](https://crates.io/crates/pros).