Skip to content
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

Jump to bottom

Enhance README with Docker usage instructions and code language flags #497

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Enhance README with Docker usage instructions and code language flags #497

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e9f233
Add Dockerfile usage instructions to README
amdadulbari Mar 28, 2023
e84a04d
Add code language flags to README for proper syntax highlighting
amdadulbari Mar 28, 2023
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
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,30 @@ operational behavior.

More information are provided in the project's [documentation](http://simona.readthedocs.io/).

## Usage and Contribution
## Usage (Docker)

To build the Docker image using the Dockerfile, you need to provide a build argument version and optionally snapshotSuffix if applicable.

```sh
docker build --build-arg version=2.1.0 --build-arg snapshotSuffix=-SNAPSHOT -t simona .
```
This command will create a Docker image named simona.

To run the Docker container, you need to mount an input directory from your host machine to the /input directory inside the container.

For Linux and macOS systems, use the following command:

```sh
docker run -v `realpath input`:/input --rm simona
```
For Windows systems, provide the absolute path to the input directory manually and escape the backslashes (\). Replace <path-to-input> with the actual path to the input directory on your system:

```sh
docker run -v <path-to-input>:/input --rm simona
```
This command will run the container with the input directory mounted, execute the simona Java application, and remove the container after the execution is finished.

## Contribution
SIMONA is part of several ongoing research projects and will be part of future research projects. Hence, the codebase
is continuously under development from different perspectives, needs and developers.

Expand Down