Getting Started

Vitruv is developed as a set of Maven packages, which can easily be included in Maven projects. Releases are published on Maven Central, while nightly snapshot builds are also published on Maven Central.

Using Vitruvius

to do

Categories of users:

• Vitruv Framework Developers
• Vitruv Application Developers
• Vitruv Application Users

Developing Vitruvius

In case you want to develop Vitruv, clone the GitHub repository and open the project in an IDE of your choice. Be aware that code needs to be generated for several of the projects, which can most easily be achieved by performing a Maven build as explained in Build and Continuous Integration.

Maven Build

To avoid incompatibilities of Maven versions, we provide a Maven wrapper (scripts mvnw and mvnw.cmd) in the repository to always use a version of Maven tested with Vitruv. The minimal required Java version is 17, since version 4.0.0 Java 21 is used.

To build a project:

• Navigate with the console to the project's root directory
• Run ./mvnw clean verify

In case there are problems:

• Set the encoding of your editors explicitly to UTF-8
• Use a Java 21 compiler (e.g., openjdk-21)
• Ensure that the code for all artifacts (meta-models, languages, etc.) has been generated, in the easiest case by running the Maven build