Skip to content

Commit 1f843a4

Browse files
karlpBOJIT
authored andcommitted
README: explain versioning goals
1 parent c67f73c commit 1f843a4

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,19 @@ code to a microcontroller can be done using the OpenOCD ARM JTAG software.
2929
Status and API
3030
--------------
3131

32-
The libopencm3 project is currently work in progress. Not all subsystems
33-
of the microcontrollers are supported, yet.
32+
The libopencm3 project is (and presumably, always will be) a work in progress.
33+
Not all subsystems of all microcontrollers are supported, yet, though some parts
34+
have more complete support than others.
3435

35-
**IMPORTANT**: The API of the library is _NOT_ yet considered stable! Please do
36-
not rely on it, yet! Changes to function names, macro names, etc.
37-
can happen at any time without prior notice!
36+
Prior to version 0.8.0, the api was largely in flux. Attempts were made to provide
37+
backwards compatibility, but this was not always considered critical.
38+
39+
From 0.8.0 to 1.0, we'll atempt to follow semver, but **EXPECT CHANGES**, as we
40+
attempt to clear up old APIs and remove deprecated functions. The 0.8.0 tag was
41+
placed to provide the "old stable" point before all the new code started landing.
42+
43+
From 1.0, expect to follow semver, with functions (and defines!) being deprecated for
44+
a release before being removed.
3845

3946
_TIP_: Include this repository as a Git submodule in your project to make sure
4047
your users get the right version of the library to compile your project.

0 commit comments

Comments
 (0)