Document that the library API is NOT yet stable!

This commit is contained in:
Uwe Hermann 2010-01-15 13:38:02 +01:00
parent 99249672d5
commit f682aa84b0
1 changed files with 9 additions and 0 deletions

9
README
View File

@ -5,6 +5,15 @@ README
The libopenstm32 project aims to create an open-source firmware library for
STM32 microcontrollers.
Status and API
--------------
The libopenstm32 project is currently work in progress. Not all subsystems
of the STM32 are supported, yet.
IMPORTANT: The API of the library is NOT yet considered stable! Please do
not rely on it, yet! Changes to function names, macro names etc.
can happen at any time without prior notice!
Building
--------