From b593268b50784964c672f8b5aaa857e9b9243634 Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 20 Dec 2019 11:26:33 +0100 Subject: Adapt documentation outline and README --- odcsim/docs/build.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'odcsim') diff --git a/odcsim/docs/build.md b/odcsim/docs/build.md index f442e70b..761fb71a 100644 --- a/odcsim/docs/build.md +++ b/odcsim/docs/build.md @@ -1 +1,4 @@ -# Building a Simulation Model +# Building Your Own Model + +--- +[< Previous](run.md) -- cgit v1.2.3 From 773eaf770313fa245250e8e1661ee50444223c98 Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 20 Dec 2019 11:37:25 +0100 Subject: Create guidelines for documentation sections --- odcsim/docs/build.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'odcsim') diff --git a/odcsim/docs/build.md b/odcsim/docs/build.md index 761fb71a..21983355 100644 --- a/odcsim/docs/build.md +++ b/odcsim/docs/build.md @@ -1,4 +1,6 @@ -# Building Your Own Model +# 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) -- cgit v1.2.3 From f33cfe79358c31cc786fdb1594cb1c40ab8e0a7b Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 14 Feb 2020 11:37:32 +0100 Subject: Get first two parts of docs up to date and remove odcsim doc --- odcsim/README.md | 12 ++---------- odcsim/docs/build.md | 6 ------ odcsim/docs/concepts.md | 0 odcsim/docs/models.md | 0 odcsim/docs/run.md | 0 5 files changed, 2 insertions(+), 16 deletions(-) delete mode 100644 odcsim/docs/build.md delete mode 100644 odcsim/docs/concepts.md delete mode 100644 odcsim/docs/models.md delete mode 100644 odcsim/docs/run.md (limited to 'odcsim') 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 diff --git a/odcsim/docs/models.md b/odcsim/docs/models.md deleted file mode 100644 index e69de29b..00000000 diff --git a/odcsim/docs/run.md b/odcsim/docs/run.md deleted file mode 100644 index e69de29b..00000000 -- cgit v1.2.3 From 4ad068f741321973a70f10755074505a3f813ebd Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 14 Feb 2020 12:28:20 +0100 Subject: Add documentation for the odcsim component --- odcsim/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'odcsim') diff --git a/odcsim/README.md b/odcsim/README.md index b0040cab..b930315a 100644 --- a/odcsim/README.md +++ b/odcsim/README.md @@ -11,8 +11,7 @@ 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). +([Actor model](https://en.wikipedia.org/wiki/Actor_model)). ## Getting Started -- cgit v1.2.3