aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorUwe Hermann2010-01-15 13:38:02 +0100
committerUwe Hermann2010-01-15 13:38:02 +0100
commitf682aa84b06a5b4717546ac525ba4185795b7ba8 (patch)
tree78f7482ff7943e1611ae4b000e8e796163d463d9 /README
parent99249672d5b46dc6a06ed6a78dd600ba44e78518 (diff)
Document that the library API is NOT yet stable!
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
index 6f5459a..70d7153 100644
--- a/README
+++ b/README
@@ -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
--------