diff --git a/README.md b/README.md index d8bfa06..cdf2856 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,16 @@ At the command line ui (-ui text / -ui oneLine) you could type in the following * stop: stop the client after the current frame has finished * cancel: cancel the stop request * quit: stop the client directly without finishing the current frame + +## Versioning scheme + +The main versioning follows the following scheme: `vA.BBCCC.D` + +* `A`: major version +* `BB`: last two digits of year (2023 -> 23) +* `CCC`: day of year with leading zeroes (340 is December 6th) +* `D`: number of repeated builds on that day + +Development versions use a different schema for "D", generated by "git describe", e.g. `v6.23006.1-14-g840d517`. + +For historic reasons, we need to make sure that neither X nor Y of X.Y.Z exceeds 5 digits to be compatible with the backend.