From 254e49e15c47c91336d2af3a0948aa474e62de5f Mon Sep 17 00:00:00 2001
From: Fabian Mastenbroek <mail.fabianm@gmail.com>
Date: Wed, 20 Nov 2019 23:02:58 +0100
Subject: chore: Tidy repository

---
 odcsim/README.md                            | 17 +++++++++++------
 odcsim/docs/build.md                        |  1 +
 odcsim/docs/concepts.md                     |  0
 odcsim/docs/models.md                       |  0
 odcsim/docs/run.md                          |  0
 odcsim/odcsim-core/build.gradle.kts         |  2 ++
 odcsim/odcsim-engine-omega/build.gradle.kts |  2 ++
 odcsim/odcsim-engine-tests/build.gradle.kts |  2 ++
 8 files changed, 18 insertions(+), 6 deletions(-)
 create mode 100644 odcsim/docs/build.md
 create mode 100644 odcsim/docs/concepts.md
 create mode 100644 odcsim/docs/models.md
 create mode 100644 odcsim/docs/run.md

(limited to 'odcsim')

diff --git a/odcsim/README.md b/odcsim/README.md
index 00d6a2fe..5863b055 100644
--- a/odcsim/README.md
+++ b/odcsim/README.md
@@ -21,9 +21,8 @@ The documentation is located in the [docs/](docs/) directory and is divided as f
 * [Main Concepts](docs/concepts.md)
 * [Building a Model](docs/build.md)
 * [Running a Model](docs/run.md)
-* [Pre-built Models](docs/models.md)
 * [API Reference](https://atlarge-research.github.io/opendc-simulator)
-* [Contributing Guide](CONTRIBUTING.md)
+* [Contributing Guide](../CONTRIBUTING.md)
 
 ## Getting Started
 
@@ -35,13 +34,19 @@ The package `odcsim-core` is required to construct a simulation model.
 A `odcsim-engine-*` package is needed for running the simulation
 model.
 
-**Gradle**
+#### Gradle 
+Groovy
 ```groovy
-compile 'com.atlarge.odcsim:odcsim-core:2.0.0'
-compile 'com.atlarge.odcsim:odcsim-engine-omega:2.0.0'
+implementation 'com.atlarge.odcsim:odcsim-core:2.0.0'
+runtime 'com.atlarge.odcsim:odcsim-engine-omega:2.0.0'
+```
+Kotlin
+```groovy
+implementation("com.atlarge.odcsim:odcsim-core:2.0.0")
+runtime("com.atlarge.odcsim:odcsim-engine-omega:2.0.0")
 ```
 
-**Maven**
+#### Maven
 ```xml
 <dependency>
    <groupId>com.atlarge.odcsim</groupId>
diff --git a/odcsim/docs/build.md b/odcsim/docs/build.md
new file mode 100644
index 00000000..f442e70b
--- /dev/null
+++ b/odcsim/docs/build.md
@@ -0,0 +1 @@
+# Building a Simulation Model
diff --git a/odcsim/docs/concepts.md b/odcsim/docs/concepts.md
new file mode 100644
index 00000000..e69de29b
diff --git a/odcsim/docs/models.md b/odcsim/docs/models.md
new file mode 100644
index 00000000..e69de29b
diff --git a/odcsim/docs/run.md b/odcsim/docs/run.md
new file mode 100644
index 00000000..e69de29b
diff --git a/odcsim/odcsim-core/build.gradle.kts b/odcsim/odcsim-core/build.gradle.kts
index 013d1598..b17cac39 100644
--- a/odcsim/odcsim-core/build.gradle.kts
+++ b/odcsim/odcsim-core/build.gradle.kts
@@ -22,6 +22,8 @@
  * SOFTWARE.
  */
 
+description = "Framework for discrete event simulation in Kotlin"
+
 /* Build configuration */
 plugins {
     `kotlin-library-convention`
diff --git a/odcsim/odcsim-engine-omega/build.gradle.kts b/odcsim/odcsim-engine-omega/build.gradle.kts
index d4383303..4540c389 100644
--- a/odcsim/odcsim-engine-omega/build.gradle.kts
+++ b/odcsim/odcsim-engine-omega/build.gradle.kts
@@ -22,6 +22,8 @@
  * SOFTWARE.
  */
 
+description = "Single-threaded reference implementation for the odcsim API"
+
 /* Build configuration */
 plugins {
     `kotlin-library-convention`
diff --git a/odcsim/odcsim-engine-tests/build.gradle.kts b/odcsim/odcsim-engine-tests/build.gradle.kts
index 7b236300..9e4931b7 100644
--- a/odcsim/odcsim-engine-tests/build.gradle.kts
+++ b/odcsim/odcsim-engine-tests/build.gradle.kts
@@ -22,6 +22,8 @@
  * SOFTWARE.
  */
 
+description = "Conformance suite for implementors of the odcsim API"
+
 /* Build configuration */
 plugins {
     `kotlin-library-convention`
-- 
cgit v1.2.3