This is the main Annot8 repository, which contains an implementation of the Annot8 API.
For components that can be used within the Annot8 framework, see the Annot8 Components repository.
The following approach is used to versioning within the Annot8 projects:
- The core Annot8 API is versioned as
major.minor(e.g.1.2). Any minor versions will be fully backwards compatible, but major versions may not be. - Projects in this repository will be versioned as
major.minor.project-version(e.g.1.2.1). Themajor.minorversion will match the API version used by the project, and will have their own project version (optionally followed by a patch level to indicate bug fixes). These projects may be developed and released at different rates, and therefore may have different project versions.
All development changes should make pull requests to the develop branch.
This should be under a -SNAPSHOT version.
For development convenience this is set to be the default branch.
Releases will be made from main and each PR to main should change the version number.
Code in this repository is licenced under the Apache Software Licence 2. See the NOTICE file for any additional restrictions.