Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcG-TUE committed Apr 25, 2022
1 parent d563943 commit 24ce1bf
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To be done.

## Building the software

The software can be built from the command line or using the provided docker image.
The software can be built from the command line or using the provided docker image. Note that the build creates both Linux and Windows scripts to run the Java based tools.

### Command line build

Expand All @@ -48,7 +48,7 @@ The built code generator can be found in:

### Building with Docker

Build the docker image:
Build the [docker](https://www.docker.com/) image:

The `Dockerfile` is located in the `/src` directory.
In the `/src` directory, run the following command to build the image.
Expand All @@ -68,6 +68,9 @@ After a successful run the results are in the mounted volume.
## Using the Software

To be done.

Note that the software requires a Java JRE to be installed on the host platform to run.

## References

<https://computationalmodeling.info>
Expand Down

0 comments on commit 24ce1bf

Please sign in to comment.