diff options
Diffstat (limited to 'odcsim')
| -rw-r--r-- | odcsim/README.md | 15 | ||||
| -rw-r--r-- | odcsim/docs/build.md | 1 | ||||
| -rw-r--r-- | odcsim/docs/concepts.md | 0 | ||||
| -rw-r--r-- | odcsim/docs/models.md | 0 | ||||
| -rw-r--r-- | odcsim/docs/run.md | 0 |
5 files changed, 3 insertions, 13 deletions
diff --git a/odcsim/README.md b/odcsim/README.md index e5dcc319..b930315a 100644 --- a/odcsim/README.md +++ b/odcsim/README.md @@ -11,21 +11,12 @@ by the [OpenDC](https://opendc.org) project. Simulations 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)), using -an API similar to [Akka](https://doc.akka.io/docs/akka/current/index.html). - -## Documentation -Check out the [Getting Started](#getting-started) section for a quick -overview. -The documentation is located in the [docs/](docs/) directory and is divided as follows: -* [Main Concepts](docs/concepts.md) -* [Building a Model](docs/build.md) -* [Running a Model](docs/run.md) -* [API Reference](https://atlarge-research.github.io/opendc-simulator) -* [Contributing Guide](../CONTRIBUTING.md) +([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/). diff --git a/odcsim/docs/build.md b/odcsim/docs/build.md deleted file mode 100644 index f442e70b..00000000 --- a/odcsim/docs/build.md +++ /dev/null @@ -1 +0,0 @@ -# Building a Simulation Model diff --git a/odcsim/docs/concepts.md b/odcsim/docs/concepts.md deleted file mode 100644 index e69de29b..00000000 --- a/odcsim/docs/concepts.md +++ /dev/null diff --git a/odcsim/docs/models.md b/odcsim/docs/models.md deleted file mode 100644 index e69de29b..00000000 --- a/odcsim/docs/models.md +++ /dev/null diff --git a/odcsim/docs/run.md b/odcsim/docs/run.md deleted file mode 100644 index e69de29b..00000000 --- a/odcsim/docs/run.md +++ /dev/null |