Skip to content

Commit 59a796f

Browse files
leogrpoiana
authored andcommitted
docs(README): add a section about versioning
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
1 parent 468af49 commit 59a796f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ plus chisels related code and common utilities.
3434
external dependencies, plus the libscap and libsinsp ones; consumers
3535
(like Falco) use those modules to build the libs in their projects.
3636

37+
## Versioning
38+
39+
This project uses two different versioning schemes for the _libs_ and _driver_ components. In particular, the _driver_ versions are suffixed with `+driver` to distinguish them from the _libs_ ones. Both adhere to the [Semantic Versioning 2.0.0](https://semver.org/). You can find more detail about how we version those components in our [release process documentation](./release.md).
40+
41+
If you build this project from a git working directory, the main [CMakeLists.txt](./CMakeLists.txt) will automatically compute the appropriate version for all components. Otherwise, if you use a source code copy with no the git information or pull the sources of the libs or the drivers directly in your project, it's up to you to correctly set the appropriate cmake variables (for example, `-DFALCOSECURITY_LIBS_VERSION=x.y.z -DDRIVER_VERSION=a.b.c+driver`).
42+
3743
## Build
3844

3945
Libs relies upon `cmake` build system.

0 commit comments

Comments
 (0)