🗑️ Deprecate package notice (#47)

README.md

@@ -1,4 +1,19 @@
-# libhal-soft
+# [DEPRECATED] libhal-soft
+
+> [!CAUTION]
+> This package is deprecated. The following files repos now have their own
+> versions of each of these files. Prefer to use these.
+>
+> - `libhal-expander`
+>   - `adc_mux.hpp`
+> - `libhal-util`
+>   - `atomic_spin_lock.hpp`
+>   - `bit_bang_i2c.hpp`
+>   - `bit_bang_spi.hpp`
+>   - `i2c_minimum_speed.hpp`
+>   - `inverter.hpp`
+> - `libhal-actuator`
+>   - `rc_servo.hpp`
 
 [![✅CI](https://github.com/libhal/libhal-soft/actions/workflows/ci.yml/badge.svg)](https://github.com/libhal/libhal-soft/actions/workflows/ci.yml)
 [![GitHub stars](https://img.shields.io/github/stars/libhal/libhal-soft.svg)](https://github.com/libhal/libhal-soft/stargazers)
@@ -7,30 +22,7 @@
 
 Library for generic soft drivers officially supported by libhal
 
-Soft drivers are drivers that do not have any specific underlying hardware associated with them. They are used to emulate, give context to, or alter the behavior of interfaces. For a driver to be a soft driver it must implement or have a way to generate, construct or create implementations of hardware interfaces.
-
-Emulation Example
-
----
-
-- Emulate spi by using 2 output pins and 1 input pin.
-- Emulate uart transmission with a 16-bit spi driver and some clever bit positioning.
-
-Context Example
-
----
-
-- Implement a rotary encoder by using an adc, a potentiometer and some specification of the potentiometer like min and max angle, along with min and max voltage.
-- Implement a dac using multiple output pins and a set of resistors and an op amp.
-
-Alteration example
-
----
-
-- Implement an input pin that inverts the readings of an actual input pin
-- Implement an i2c driver that is thread safe by taking an i2c and locking mechanism provided by the user.
-
-In general, software drivers tend to incur some overhead so nesting them deeply will effect performance.
+Soft drivers are drivers that combine hardware interfaces together to emulate the behavior of other interfaces. For a driver to be a soft driver it must implement or have a way to generate, construct or create implementations of hardware interfaces.
 
 ## Contributing