Skip to content

Remove securiCAD backend build instructions from README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrkickling merged 1 commit into from
Dec 5, 2025
Merged

Remove securiCAD backend build instructions from README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ The
compiles MAL specifications (`.mal` files) into different formats,
using different backends. The reference backend generates Java code
that is suitable for testing purposes and evaluating your language.
The securiCAD backend generates a `.jar` file that can be used with
[foreseeti](https://foreseeti.com)'s products, including
[securiCAD](https://foreseeti.com/securicad), which is a tool
that can be used to graphically create models using your language and
to simulate attacks on those models.

### Building with the reference backend and running the unit tests

Expand Down Expand Up @@ -84,29 +79,6 @@ mvn test -Dtest=TestExampleLang#testNoPassword
Where `TestExampleLang` is the test class and `testNoPassword` is the
test method.

### Building a securiCAD compatible .jar file

In order to use your language with foreseeti’s products, it is necessary to build a securiCAD-compatible `.jar` file and to obtain a copy of the securiCAD software.

foreseeti offers a free version of the securiCAD Professional tool for MAL developers. Sign up [here](https://foreseeti.com/foreseeti-getting-started/) to get access to the securiCAD Professional tool as well as instruction on how to access the foreseeti Maven repository.

To compile exampleLang with the securiCAD backend of the MAL
compiler, execute the following command:

```
mvn package -PsecuriCAD
```

The resulting `.jar` file will be located in
`target/examplelang-1.0.0.jar`.

If you don't want to run the unit tests when building a securiCAD
compatible `.jar` file, execute the following command:

```
mvn clean package -PsecuriCAD -Dmaven.test.skip=true
```

## Using exampleLang as a template MAL language

To create a new language using exampleLang as a template, you need to
Expand Down Expand Up @@ -138,9 +110,6 @@ do the following:
* Update `<mal.file>` with the name of the main MAL specification
of your language
* Example: `myLang.mal`
* Update `<mal.securicad.package>` with the package name of your
language
* Example: `com.example.mylang`
* Update `<mal.reference.package>` with the test package name of
your language
* Example: `com.example.mylang.test`
Expand Down
Loading