diff options
| author | Georgios Andreadis <info@gandreadis.com> | 2020-02-14 11:37:32 +0100 |
|---|---|---|
| committer | Georgios Andreadis <info@gandreadis.com> | 2020-02-14 19:14:31 +0100 |
| commit | f33cfe79358c31cc786fdb1594cb1c40ab8e0a7b (patch) | |
| tree | 2075fc68f9aaa49d93e2d1c018fc2f877d683bef /odcsim | |
| parent | 773eaf770313fa245250e8e1661ee50444223c98 (diff) | |
Get first two parts of docs up to date and remove odcsim doc
Diffstat (limited to 'odcsim')
| -rw-r--r-- | odcsim/README.md | 12 | ||||
| -rw-r--r-- | odcsim/docs/build.md | 6 | ||||
| -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, 2 insertions, 16 deletions
diff --git a/odcsim/README.md b/odcsim/README.md index e5dcc319..b0040cab 100644 --- a/odcsim/README.md +++ b/odcsim/README.md @@ -14,18 +14,10 @@ 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) - ## 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 21983355..00000000 --- a/odcsim/docs/build.md +++ /dev/null @@ -1,6 +0,0 @@ -# 5. Building Your Own Model - -**TODO: What goes into building a model? Where do you start? Can be quite technical (what gradle scripts do I need to make, what directory structure, ...), maybe center around a simple example scenario?** - ---- -[< Previous](run.md) 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 |