diff --git a/README.md b/README.md new file mode 100644 index 0000000..16d217a --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Interfaces + +The intention of these interfaces is to provide an abstraction layer for commonly used +resources. Libraries using these interfaces can be reused on different platforms +by simply implementing the required interfaces for the selected platform. + +Interfaces for the following resources are provided: +* GPIO pin +* Mutex +* Signal +* SPI +* UART + + +# HAL implementations + +Implementations using the HAL are provided for the following interfaces: +* GpioPin +* SpiInterface, SpiDevice +* UART + + +# Atomic implementations + +Implementations using atomic variables are provided for the following interfaces: +* Mutex +* Signal \ No newline at end of file