summaryrefslogtreecommitdiff
path: root/simulator/odcsim/README.md
diff options
context:
space:
mode:
authorFabian Mastenbroek <mail.fabianm@gmail.com>2020-10-01 10:24:17 +0200
committerGitHub <noreply@github.com>2020-10-01 10:24:17 +0200
commit5d71ef4bd6ca84cf5f445f7ba4bb5f7a1e181b64 (patch)
tree378ee03042636dde384e4c7eb98aef00f5d3213c /simulator/odcsim/README.md
parent1656a77645079754fc31cffad9d0af6d92e184ee (diff)
parenta283fac5e4d2a6be229acba191acdcbf7eba6dcd (diff)
Merge pull request #42 from atlarge-research/refactor/clean-up
Remove odcsim component from OpenDC
Diffstat (limited to 'simulator/odcsim/README.md')
-rw-r--r--simulator/odcsim/README.md54
1 files changed, 0 insertions, 54 deletions
diff --git a/simulator/odcsim/README.md b/simulator/odcsim/README.md
deleted file mode 100644
index 78cfaa27..00000000
--- a/simulator/odcsim/README.md
+++ /dev/null
@@ -1,54 +0,0 @@
-<h1 align="center">
- <a href="http://opendc.org/">
- <img src="../misc/artwork/logo.png" width="100" alt="OpenDC">
- </a>
- <br>
- odcsim
-</h1>
-
-## Introduction
-**odcsim** is a framework for discrete event simulation in Kotlin, used
-by the [OpenDC](https://opendc.org) project.
-Projects are defined in terms of a hierarchical grouping of actors
-and the interactions between these actors
-([Actor model](https://en.wikipedia.org/wiki/Actor_model)).
-
-## Getting Started
-
-The instructions below are meant for when you would like to use `odcsim` separately from `opendc`. If you simply want to use the simulator, you do not need to follow them, please refer to the [main README](../README.md) for instructions.
-
-### Installation
-Please add the required packages as dependency in your project.
-Releases are available in the [Maven Central Repository](https://search.maven.org/).
-
-The package `odcsim-core` is required to construct a simulation model.
-A `odcsim-engine-*` package is needed for running the simulation
-model.
-
-#### Gradle
-Groovy
-```groovy
-implementation 'com.atlarge.odcsim:odcsim-api:2.0.0'
-runtime 'com.atlarge.odcsim:odcsim-engine-omega:2.0.0'
-```
-Kotlin
-```groovy
-implementation("com.atlarge.odcsim:odcsim-api:2.0.0")
-runtime("com.atlarge.odcsim:odcsim-engine-omega:2.0.0")
-```
-
-#### Maven
-```xml
-<dependency>
- <groupId>com.atlarge.odcsim</groupId>
- <artifactId>odcsim-api</artifactId>
- <version>2.0.0</version>
-</dependency>
-
-<dependency>
- <groupId>com.atlarge.odcsim</groupId>
- <artifactId>odcsim-engine-omega</artifactId>
- <version>2.0.0</version>
-</dependency>
-```
-