From b666c7b7f37a4b5e28419b7c38339049e7428f8c Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Sat, 2 Mar 2024 02:49:22 -0800 Subject: [PATCH 1/9] docs: add readme and liscence to all new crates --- packages/pros-async/Cargo.toml | 2 ++ packages/pros-async/README.md | 6 ++++++ packages/pros-core/Cargo.toml | 2 ++ packages/pros-core/README.md | 11 +++++++++++ packages/pros-devices/Cargo.toml | 2 ++ packages/pros-devices/README.md | 15 +++++++++++++++ packages/pros-math/Cargo.toml | 2 ++ packages/pros-math/src/README.md | 3 +++ packages/pros-panic/Cargo.toml | 2 ++ packages/pros-panic/README.md | 5 +++++ packages/pros-sync/Cargo.toml | 2 ++ packages/pros-sync/README.md | 1 + 12 files changed, 53 insertions(+) create mode 100644 packages/pros-async/README.md create mode 100644 packages/pros-core/README.md create mode 100644 packages/pros-devices/README.md create mode 100644 packages/pros-math/src/README.md create mode 100644 packages/pros-panic/README.md create mode 100644 packages/pros-sync/README.md diff --git a/packages/pros-async/Cargo.toml b/packages/pros-async/Cargo.toml index cdff9b30..5f88a77b 100644 --- a/packages/pros-async/Cargo.toml +++ b/packages/pros-async/Cargo.toml @@ -2,6 +2,8 @@ name = "pros-async" version = "0.1.0" edition = "2021" +license = "MIT" +description = "A simple async executor for pros-rs" # 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 new file mode 100644 index 00000000..abc23d78 --- /dev/null +++ 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 index 60fc43d1..4430d545 100644 --- a/packages/pros-core/Cargo.toml +++ b/packages/pros-core/Cargo.toml @@ -2,6 +2,8 @@ name = "pros-core" version = "0.1.0" edition = "2021" +license = "MIT" +description = "Core functionality for pros-rs" # 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 new file mode 100644 index 00000000..cd2a7a3b --- /dev/null +++ b/packages/pros-core/README.md @@ -0,0 +1,11 @@ +# 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 +- Competition state checking +- Errno handling +- Serial terminal printing +- No-std `Instant`s +- Synchronization primitives +- FreeRTOS task management diff --git a/packages/pros-devices/Cargo.toml b/packages/pros-devices/Cargo.toml index 17a62012..9919ac9f 100644 --- a/packages/pros-devices/Cargo.toml +++ b/packages/pros-devices/Cargo.toml @@ -2,6 +2,8 @@ name = "pros-devices" version = "0.1.0" edition = "2021" +license = "MIT" +description = "High level device for pros-rs" # 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 new file mode 100644 index 00000000..6054c421 --- /dev/null +++ b/packages/pros-devices/README.md @@ -0,0 +1,15 @@ +This module provides functionality for accessing hardware annected to the V5 brain. + +# Overview + +The V5 brain features 21 RJ9 4p4c connector ports (known as "Smart ts")for communicating with +newer V5 peripherals, as well as six 3-wire ports with log-to-digitalconversion capability for +compatibility with legacy cortex devices. This module provides access 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-math/Cargo.toml b/packages/pros-math/Cargo.toml index 279a41d8..c9ec93ad 100644 --- a/packages/pros-math/Cargo.toml +++ b/packages/pros-math/Cargo.toml @@ -2,6 +2,8 @@ name = "pros-math" version = "0.1.0" edition = "2021" +license = "MIT" +description = "Commonly used mathematical formulas for pros-rs" [dependencies] num = { version = "0.4.1", default-features = false } diff --git a/packages/pros-math/src/README.md b/packages/pros-math/src/README.md new file mode 100644 index 00000000..ea2cda52 --- /dev/null +++ b/packages/pros-math/src/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 index 0314c46c..f74e5478 100644 --- a/packages/pros-panic/Cargo.toml +++ b/packages/pros-panic/Cargo.toml @@ -2,6 +2,8 @@ name = "pros-panic" version = "0.1.0" edition = "2021" +license = "MIT" +description = "Panic handler for pros-rs" # 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 new file mode 100644 index 00000000..9b485e8a --- /dev/null +++ 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 index 1df90f53..45eee70e 100644 --- a/packages/pros-sync/Cargo.toml +++ b/packages/pros-sync/Cargo.toml @@ -2,6 +2,8 @@ name = "pros-sync" version = "0.1.0" edition = "2021" +license = "MIT" +description = "`SyncRobot` trait and macro for pros-rs" # 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 new file mode 100644 index 00000000..e1804501 --- /dev/null +++ b/packages/pros-sync/README.md @@ -0,0 +1 @@ +Synchronous robot code trait for [pros-rs](https://crates.io/crates/pros). From 96d16535f484369a2b9b0da49daeb58ac9cb8f04 Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Sat, 2 Mar 2024 02:54:04 -0800 Subject: [PATCH 2/9] docs: add keywords and categories to new crates --- packages/pros-async/Cargo.toml | 6 ++++++ packages/pros-core/Cargo.toml | 6 ++++++ packages/pros-devices/Cargo.toml | 6 ++++++ packages/pros-math/Cargo.toml | 5 +++++ packages/pros-panic/Cargo.toml | 5 +++++ packages/pros-sync/Cargo.toml | 5 +++++ 6 files changed, 33 insertions(+) diff --git a/packages/pros-async/Cargo.toml b/packages/pros-async/Cargo.toml index 5f88a77b..e5292c76 100644 --- a/packages/pros-async/Cargo.toml +++ b/packages/pros-async/Cargo.toml @@ -4,6 +4,12 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "A simple async executor for pros-rs" +keywords = ["PROS", "Robotics", "bindings", "async"] +categories = [ + "no-std", + "science::robotics", + "Asynchronous" +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-core/Cargo.toml b/packages/pros-core/Cargo.toml index 4430d545..fe7407b1 100644 --- a/packages/pros-core/Cargo.toml +++ b/packages/pros-core/Cargo.toml @@ -4,6 +4,12 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "Core functionality for pros-rs" +keywords = ["PROS", "Robotics", "bindings"] +categories = [ + "api-bindings", + "no-std", + "science::robotics", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-devices/Cargo.toml b/packages/pros-devices/Cargo.toml index 9919ac9f..b9b23a29 100644 --- a/packages/pros-devices/Cargo.toml +++ b/packages/pros-devices/Cargo.toml @@ -4,6 +4,12 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "High level device for pros-rs" +keywords = ["PROS", "Robotics", "bindings"] +categories = [ + "api-bindings", + "no-std", + "science::robotics", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-math/Cargo.toml b/packages/pros-math/Cargo.toml index c9ec93ad..64b70cb8 100644 --- a/packages/pros-math/Cargo.toml +++ b/packages/pros-math/Cargo.toml @@ -4,6 +4,11 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "Commonly used mathematical formulas for pros-rs" +keywords = ["PROS", "Robotics"] +categories = [ + "no-std", + "science::robotics", +] [dependencies] num = { version = "0.4.1", default-features = false } diff --git a/packages/pros-panic/Cargo.toml b/packages/pros-panic/Cargo.toml index f74e5478..174b085e 100644 --- a/packages/pros-panic/Cargo.toml +++ b/packages/pros-panic/Cargo.toml @@ -4,6 +4,11 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "Panic handler for pros-rs" +keywords = ["PROS", "Robotics"] +categories = [ + "no-std", + "science::robotics", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-sync/Cargo.toml b/packages/pros-sync/Cargo.toml index 45eee70e..176ac926 100644 --- a/packages/pros-sync/Cargo.toml +++ b/packages/pros-sync/Cargo.toml @@ -4,6 +4,11 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "`SyncRobot` trait and macro for pros-rs" +keywords = ["PROS", "Robotics"] +categories = [ + "no-std", + "science::robotics", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html From 14f6a46cc4e5f484315896e8fe45cd68feb2c041 Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Sat, 2 Mar 2024 02:56:09 -0800 Subject: [PATCH 3/9] docs: add authors to new crates --- packages/pros-async/Cargo.toml | 6 ++++++ packages/pros-core/Cargo.toml | 6 ++++++ packages/pros-devices/Cargo.toml | 6 ++++++ packages/pros-math/Cargo.toml | 6 ++++++ packages/pros-panic/Cargo.toml | 6 ++++++ packages/pros-sync/Cargo.toml | 6 ++++++ 6 files changed, 36 insertions(+) diff --git a/packages/pros-async/Cargo.toml b/packages/pros-async/Cargo.toml index e5292c76..6f5f7c60 100644 --- a/packages/pros-async/Cargo.toml +++ b/packages/pros-async/Cargo.toml @@ -10,6 +10,12 @@ categories = [ "science::robotics", "Asynchronous" ] +repository = "https://github.com/gavin-niederman/pros-rs" +authors = [ + "pros-rs", + "Gavin Niederman ", + "doinkythederp ", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-core/Cargo.toml b/packages/pros-core/Cargo.toml index fe7407b1..8c8178d2 100644 --- a/packages/pros-core/Cargo.toml +++ b/packages/pros-core/Cargo.toml @@ -10,6 +10,12 @@ categories = [ "no-std", "science::robotics", ] +repository = "https://github.com/gavin-niederman/pros-rs" +authors = [ + "pros-rs", + "Gavin Niederman ", + "doinkythederp ", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-devices/Cargo.toml b/packages/pros-devices/Cargo.toml index b9b23a29..dcd81671 100644 --- a/packages/pros-devices/Cargo.toml +++ b/packages/pros-devices/Cargo.toml @@ -10,6 +10,12 @@ categories = [ "no-std", "science::robotics", ] +repository = "https://github.com/gavin-niederman/pros-rs" +authors = [ + "pros-rs", + "Gavin Niederman ", + "doinkythederp ", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-math/Cargo.toml b/packages/pros-math/Cargo.toml index 64b70cb8..64c5d8f2 100644 --- a/packages/pros-math/Cargo.toml +++ b/packages/pros-math/Cargo.toml @@ -9,6 +9,12 @@ categories = [ "no-std", "science::robotics", ] +repository = "https://github.com/gavin-niederman/pros-rs" +authors = [ + "pros-rs", + "Gavin Niederman ", + "doinkythederp ", +] [dependencies] num = { version = "0.4.1", default-features = false } diff --git a/packages/pros-panic/Cargo.toml b/packages/pros-panic/Cargo.toml index 174b085e..96cd07ef 100644 --- a/packages/pros-panic/Cargo.toml +++ b/packages/pros-panic/Cargo.toml @@ -9,6 +9,12 @@ categories = [ "no-std", "science::robotics", ] +repository = "https://github.com/gavin-niederman/pros-rs" +authors = [ + "pros-rs", + "Gavin Niederman ", + "doinkythederp ", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/pros-sync/Cargo.toml b/packages/pros-sync/Cargo.toml index 176ac926..358193de 100644 --- a/packages/pros-sync/Cargo.toml +++ b/packages/pros-sync/Cargo.toml @@ -9,6 +9,12 @@ categories = [ "no-std", "science::robotics", ] +repository = "https://github.com/gavin-niederman/pros-rs" +authors = [ + "pros-rs", + "Gavin Niederman ", + "doinkythederp ", +] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html From c3222e94968c68f8dcf35602c04bcfc4fd59ec3b Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Sat, 2 Mar 2024 03:06:56 -0800 Subject: [PATCH 4/9] docs: update pros-devices readme --- packages/pros-devices/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/pros-devices/README.md b/packages/pros-devices/README.md index 6054c421..6c0f5042 100644 --- a/packages/pros-devices/README.md +++ b/packages/pros-devices/README.md @@ -1,4 +1,6 @@ -This module provides functionality for accessing hardware annected to the V5 brain. +# pros-devices + +functionality for accessing hardware connected to the V5 brain. # Overview From 89354609944228e9a5c2a5ded89ed60963f91e89 Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Sat, 2 Mar 2024 03:08:04 -0800 Subject: [PATCH 5/9] docs: update pros-sync readme --- packages/pros-sync/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/pros-sync/README.md b/packages/pros-sync/README.md index e1804501..e65db59a 100644 --- a/packages/pros-sync/README.md +++ b/packages/pros-sync/README.md @@ -1 +1,3 @@ +# pros-sync + Synchronous robot code trait for [pros-rs](https://crates.io/crates/pros). From 691a58547351a1129d50e71209c461701a254ffb Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Sat, 2 Mar 2024 03:11:39 -0800 Subject: [PATCH 6/9] fix: move pros-math readme into crate directory --- packages/pros-math/{src => }/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename packages/pros-math/{src => }/README.md (100%) diff --git a/packages/pros-math/src/README.md b/packages/pros-math/README.md similarity index 100% rename from packages/pros-math/src/README.md rename to packages/pros-math/README.md From 9acac8df811e65965504c64203ed133714787b74 Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Tue, 5 Mar 2024 20:30:44 -0800 Subject: [PATCH 7/9] docs: correct grammar errors --- packages/pros-devices/README.md | 11 ++++------- packages/pros-devices/src/lib.rs | 13 +++++-------- packages/pros-sys/README.md | 4 ++-- 3 files changed, 11 insertions(+), 17 deletions(-) diff --git a/packages/pros-devices/README.md b/packages/pros-devices/README.md index 6c0f5042..b5e924ee 100644 --- a/packages/pros-devices/README.md +++ b/packages/pros-devices/README.md @@ -1,15 +1,12 @@ # pros-devices -functionality for accessing hardware 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 ts")for communicating with -newer V5 peripherals, as well as six 3-wire ports with log-to-digitalconversion capability for -compatibility with legacy cortex devices. This module provides access 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 ices. - `adi` contains abstractions for three wire ADI connected devices. diff --git a/packages/pros-devices/src/lib.rs b/packages/pros-devices/src/lib.rs index f4c7dfe0..d3e19f4e 100644 --- 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-sys/README.md b/packages/pros-sys/README.md index 2623d9de..9182522b 100644 --- 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) From ce8ed54a027c06a440d27da0a0108d3c4c94512f Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Tue, 5 Mar 2024 20:37:22 -0800 Subject: [PATCH 8/9] docs: add vex and v5 to crate keywords --- packages/pros-async/Cargo.toml | 2 +- packages/pros-core/Cargo.toml | 2 +- packages/pros-devices/Cargo.toml | 2 +- packages/pros-math/Cargo.toml | 3 ++- packages/pros-panic/Cargo.toml | 2 +- packages/pros-sync/Cargo.toml | 2 +- packages/pros-sys/Cargo.toml | 2 +- packages/pros/Cargo.toml | 2 +- 8 files changed, 9 insertions(+), 8 deletions(-) diff --git a/packages/pros-async/Cargo.toml b/packages/pros-async/Cargo.toml index 6f5f7c60..498b9af2 100644 --- a/packages/pros-async/Cargo.toml +++ b/packages/pros-async/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "A simple async executor for pros-rs" -keywords = ["PROS", "Robotics", "bindings", "async"] +keywords = ["PROS", "Robotics", "bindings", "async", "vex", "v5"] categories = [ "no-std", "science::robotics", diff --git a/packages/pros-core/Cargo.toml b/packages/pros-core/Cargo.toml index 8c8178d2..ed6c827a 100644 --- a/packages/pros-core/Cargo.toml +++ b/packages/pros-core/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "Core functionality for pros-rs" -keywords = ["PROS", "Robotics", "bindings"] +keywords = ["PROS", "Robotics", "bindings", "vex", "v5"] categories = [ "api-bindings", "no-std", diff --git a/packages/pros-devices/Cargo.toml b/packages/pros-devices/Cargo.toml index dcd81671..6d49ac81 100644 --- a/packages/pros-devices/Cargo.toml +++ b/packages/pros-devices/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "High level device for pros-rs" -keywords = ["PROS", "Robotics", "bindings"] +keywords = ["PROS", "Robotics", "bindings", "vex", "v5"] categories = [ "api-bindings", "no-std", diff --git a/packages/pros-math/Cargo.toml b/packages/pros-math/Cargo.toml index 64c5d8f2..e2a39aca 100644 --- a/packages/pros-math/Cargo.toml +++ b/packages/pros-math/Cargo.toml @@ -4,10 +4,11 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "Commonly used mathematical formulas for pros-rs" -keywords = ["PROS", "Robotics"] +keywords = ["PROS", "Robotics", "vex", "v5"] categories = [ "no-std", "science::robotics", + "Mathematics", ] repository = "https://github.com/gavin-niederman/pros-rs" authors = [ diff --git a/packages/pros-panic/Cargo.toml b/packages/pros-panic/Cargo.toml index 96cd07ef..39237284 100644 --- a/packages/pros-panic/Cargo.toml +++ b/packages/pros-panic/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "Panic handler for pros-rs" -keywords = ["PROS", "Robotics"] +keywords = ["PROS", "Robotics", "vex", "v5"] categories = [ "no-std", "science::robotics", diff --git a/packages/pros-sync/Cargo.toml b/packages/pros-sync/Cargo.toml index 358193de..e30b4f0b 100644 --- a/packages/pros-sync/Cargo.toml +++ b/packages/pros-sync/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" edition = "2021" license = "MIT" description = "`SyncRobot` trait and macro for pros-rs" -keywords = ["PROS", "Robotics"] +keywords = ["PROS", "Robotics", "vex", "v5"] categories = [ "no-std", "science::robotics", diff --git a/packages/pros-sys/Cargo.toml b/packages/pros-sys/Cargo.toml index 145824f7..682b1784 100644 --- 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/Cargo.toml b/packages/pros/Cargo.toml index 2df5fa64..4740916b 100644 --- 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" From dc115463c5931443423c5ccd5a45a20280f8c169 Mon Sep 17 00:00:00 2001 From: Gavin-Niederman Date: Tue, 5 Mar 2024 20:43:43 -0800 Subject: [PATCH 9/9] fix: remove competition state checking from pros-core docs --- packages/pros-core/README.md | 1 - packages/pros-core/src/lib.rs | 1 - 2 files changed, 2 deletions(-) diff --git a/packages/pros-core/README.md b/packages/pros-core/README.md index cd2a7a3b..fd26132c 100644 --- a/packages/pros-core/README.md +++ b/packages/pros-core/README.md @@ -3,7 +3,6 @@ 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 -- Competition state checking - Errno handling - Serial terminal printing - No-std `Instant`s diff --git a/packages/pros-core/src/lib.rs b/packages/pros-core/src/lib.rs index dc868f74..67838b74 100644 --- 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`]