Skip to content
Levi Starrett edited this page Jan 26, 2020 · 10 revisions

Jump Start

In this section, we will go start to finish on how to create, build, and run an xtUML project from scratch. This guide assumes some basic knowledge of how to use BridgePoint. For help with BridgePoint and xtUML, please visit xtUML.org.

Example projects

If you have not already, go to the examples page of the repository. That is a great place to start if you find yourself wanting to learn by viewing existing projects.

Dependencies

On Ubuntu linux:

sudo apt-get update && sudo apt-get install -y maven python-pip wget unzip
pip install pyxtuml
wget https://s3.amazonaws.com/xtuml-releases/nightly-build/org.xtuml.bp.product-linux.gtk.x86_64.zip
unzip https://s3.amazonaws.com/xtuml-releases/nightly-build/org.xtuml.bp.product-linux.gtk.x86_64.zip

On macOS:

brew install maven wget unzip
pip install pyxtuml
wget https://s3.amazonaws.com/xtuml-releases/nightly-build/org.xtuml.bp.product-macosx.cocoa.x86_64.zip
unzip https://s3.amazonaws.com/xtuml-releases/nightly-build/org.xtuml.bp.product-macosx.cocoa.x86_64.zip

Download the Ciera runtime library

Note
This step is not necessary if you have build a Ciera project before (including the examples). It simply downloads the runtime library (including modeled artifacts).

In a terminal window:

mvn -DgroupId=io.ciera -DartifactId=runtime -Dversion=1.1.11 dependency:get

Creating an xtUML project

  1. Open BridgePoint and create a new xtUML project. Call the project "MyCieraProject"

  2. Create a new package, component, package, and function in the project. Name them "system", "test", "functions", and "foo" respectively. Your tree should now look something like this:

    Project Tree
  3. Enable inter-project references. Right click on project > Properties > xtUML Project > Inter-project References.

Clone this wiki locally