Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 2.7 KB

README.md

File metadata and controls

72 lines (48 loc) · 2.7 KB
Raw

Build and Test Release (latest SemVer)

The SUTURO semantic map editor is a Java-based tool to create and edit semantic maps.

Requirements

  • Java 17 or higher

Usage

...

Contributing

Recommend Code Editor

We recommend using IntelliJ IDEA as code editor for this project with the following plugins:

  • Lombok

Getting Started

  1. Open the project in IntelliJ IDEA
  2. Execute the Run-Configuration Run Semantic Map Editor

The project follows the principles of Domain Driven Design (DDD). The project structure is therefor divided into multiple Gradle modules to follow the hexagonal architecture. For more information about DDD, see the following

Create a Release

To publish a new release, you need to create a new tag with the version number and push it to the repository. The release is then published automatically by the GitHub Actions release.yml workflow.

Example:

git tag -a 1.3.0 -m "v1.3.0" -m "- Fix bug in URDF export"
git push origin 1.3.0
  • The tag name should be a valid SemVer version number.
  • The tag message head should start with a v prefix and then the tag name (e.g. v1.3.0).
  • The tag message body should contain a short description of the changes since the last release.

License

The SUTURO semantic map editor is licensed under the Apache License, Version 2.0. See the LICENSE file for details.