docs: add maintenance status

lewisfm · lewisfm · commit 9be28065fb9d · 2026-02-26T00:10:27.000-05:00
diff --git a/README.md b/README.md
@@ -2,9 +2,12 @@
 
 Opinionated Rust bindings for the [PROS](https://github.com/purduesigbots/pros) library and kernel.
 
-> [!IMPORTANT]
->
-> This project is not currently in development. If this looks interesting to you, check out [`vexide`](https://github.com/vexide/vexide) instead!
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
+
+> [!important]
+> pros-rs is deprecated and unmaintained; new projects should instead use
+> [`vexide`](https://crates.io/crates/vexide), a similar library with features like differential
+> uploading and `std` support.
 
 ## Usage
 
@@ -34,7 +37,7 @@ There is a ``.envrc`` file included for Nix + Direnv users.
 
 #### Without Nix
 
-Install arm-none-eabi-gcc and pros-cli from your package manager of choice. 
+Install arm-none-eabi-gcc and pros-cli from your package manager of choice.
 Cargo pros can be installed with ``cargo install cargo-pros``.
 
 ### MacOS
@@ -57,7 +60,7 @@ And you are done! Compile the project with `cargo build`.
 To build projects in this repository for WebAssembly, run ``cargo pros build -s``
 This will automatically pass all of the correct arguments to cargo.
 
-If for some reason you want to do it manually, this is the command: 
+If for some reason you want to do it manually, this is the command:
 `cargo build --target wasm32-unknown-unknown -Zbuild-std=std,panic_abort`.
 
 The extra build-std argument is neccesary because this repository's `.cargo/config.toml` enables build-std but only for core, alloc, and compiler_builtins. WebAssembly does come with `std` but there is [currently](https://github.com/rust-lang/cargo/issues/8733) no way to conditionally enable build-std.
diff --git a/packages/pros-async/Cargo.toml b/packages/pros-async/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pros-async"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 license = "MIT"
 description = "A simple async executor for pros-rs"
@@ -27,3 +27,6 @@ pros-sys = { version = "0.8.0", path = "../pros-sys" }
 
 [lints]
 workspace = true
+
+[badges]
+maintenance.status = "deprecated"
diff --git a/packages/pros-async/README.md b/packages/pros-async/README.md
@@ -1,6 +1,14 @@
 # pros-async
 
 Tiny async runtime and robot traits for `pros-rs`.
+
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
+
+> [!important]
+> pros-rs is deprecated and unmaintained; new projects should instead use
+> [`vexide`](https://crates.io/crates/vexide), a similar library with features like differential
+> uploading and `std` support.
+
 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
@@ -1,6 +1,6 @@
 [package]
 name = "pros-core"
-version = "0.1.1"
+version = "0.1.2"
 edition = "2021"
 license = "MIT"
 description = "Core functionality for pros-rs"
@@ -33,3 +33,6 @@ dlmalloc = { version = "0.2.4", features = ["global"] }
 
 [lints]
 workspace = true
+
+[badges]
+maintenance.status = "deprecated"
diff --git a/packages/pros-core/README.md b/packages/pros-core/README.md
@@ -1,6 +1,16 @@
 # 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.
+
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
+
+> [!important]
+> pros-rs is deprecated and unmaintained; new projects should instead use
+> [`vexide`](https://crates.io/crates/vexide), a similar library with features like differential
+> uploading and `std` support.
+
+This core crate is used in all other crates in the pros-rs ecosystem.
+
 Included in this crate:
 - Global allocator
 - Errno handling
diff --git a/packages/pros-devices/Cargo.toml b/packages/pros-devices/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pros-devices"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 license = "MIT"
 description = "High level device for pros-rs"
@@ -34,3 +34,6 @@ workspace = true
 
 [features]
 dangerous_motor_tuning = []
+
+[badges]
+maintenance.status = "deprecated"
diff --git a/packages/pros-devices/README.md b/packages/pros-devices/README.md
@@ -2,6 +2,13 @@
 
 Functionality for accessing hardware connected to the V5 brain.
 
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
+
+> [!important]
+> pros-rs is deprecated and unmaintained; new projects should instead use
+> [`vexide`](https://crates.io/crates/vexide), a similar library with features like differential
+> uploading and `std` support.
+
 ## 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.
diff --git a/packages/pros-math/Cargo.toml b/packages/pros-math/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pros-math"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 license = "MIT"
 description = "Commonly used mathematical formulas for pros-rs"
@@ -23,3 +23,6 @@ pros-core = { version = "0.1.0", path = "../pros-core" }
 
 [lints]
 workspace = true
+
+[badges]
+maintenance.status = "deprecated"
diff --git a/packages/pros-math/README.md b/packages/pros-math/README.md
@@ -1,3 +1,10 @@
 # pros-math
 
 Common mathematical formulas and models implemented for [`pros-rs`](https://crates.io/crates/pros).
+
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
+
+> [!important]
+> pros-rs is deprecated and unmaintained; new projects should instead use
+> [`vexide`](https://crates.io/crates/vexide), a similar library with features like differential
+> uploading and `std` support.
diff --git a/packages/pros-panic/Cargo.toml b/packages/pros-panic/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pros-panic"
-version = "0.1.1"
+version = "0.1.2"
 edition = "2021"
 license = "MIT"
 description = "Panic handler for pros-rs"
@@ -30,3 +30,6 @@ display_panics = ["dep:pros-devices"]
 
 [lints]
 workspace = true
+
+[badges]
+maintenance.status = "deprecated"
diff --git a/packages/pros-panic/README.md b/packages/pros-panic/README.md
@@ -1,5 +1,13 @@
 # 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.
+
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
+
+> [!important]
+> pros-rs is deprecated and unmaintained; new projects should instead use
+> [`vexide`](https://crates.io/crates/vexide), a similar library with features like differential
+> uploading and `std` support.
diff --git a/packages/pros-sync/Cargo.toml b/packages/pros-sync/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pros-sync"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 license = "MIT"
 description = "`SyncRobot` trait and macro for pros-rs"
@@ -23,3 +23,6 @@ pros-core = { version = "0.1.0", path = "../pros-core" }
 
 [lints]
 workspace = true
+
+[badges]
+maintenance.status = "deprecated"
diff --git a/packages/pros-sync/README.md b/packages/pros-sync/README.md
@@ -1,3 +1,10 @@
 # pros-sync
 
 Synchronous robot code trait for [pros-rs](https://crates.io/crates/pros).
+
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
+
+> [!important]
+> pros-rs is deprecated and unmaintained; new projects should instead use
+> [`vexide`](https://crates.io/crates/vexide), a similar library with features like differential
+> uploading and `std` support.
diff --git a/packages/pros-sys/Cargo.toml b/packages/pros-sys/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pros-sys"
-version = "0.8.0"
+version = "0.8.1"
 edition = "2021"
 description = "EFI for the PROS rust bindings"
 keywords = ["PROS", "Robotics", "bindings", "vex", "v5"]
@@ -27,3 +27,6 @@ cfg-if = "1.0"
 
 [dependencies]
 cfg-if = "1.0"
+
+[badges]
+maintenance.status = "deprecated"
diff --git a/packages/pros-sys/README.md b/packages/pros-sys/README.md
@@ -2,6 +2,10 @@
 
 EFI for Rust PROS bindings, used in [pros-rs](https://crates.io/crates/pros)
 
-## This project is still very early in development
+![Maintained: no](https://img.shields.io/maintenance/no/2024)
 
-Make sure to check out the todo list [(TODO.md)](../TODO.md)
+> [!important]
+> pros-rs and the `pros-sys` crate are deprecated and unmaintained. Consider using
+> [`vex-sdk`](https://crates.io/crates/vex-sdk) instead, a more flexible library with
+> similar APIs which doesn't need to depend on `libpros.a`. Alternatively, consider
+> [`vexide`](https://crates.io/crates/vex-sdk) if you are looking for a higher-level framework.
diff --git a/packages/pros/Cargo.toml b/packages/pros/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "pros"
-version = "0.9.0"
+version = "0.9.1"
 edition = "2021"
 description = "Rust bindings for PROS"
 keywords = ["PROS", "Robotics", "bindings", "vex", "v5"]
@@ -42,3 +42,6 @@ panic = ["dep:pros-panic"]
 display_panics = ["pros-panic/display_panics"]
 
 dangerous-motor-tuning = ["pros-devices/dangerous_motor_tuning"]
+
+[badges]
+maintenance.status = "deprecated"
