summaryrefslogtreecommitdiff
path: root/odcsim
diff options
context:
space:
mode:
authorFabian Mastenbroek <mail.fabianm@gmail.com>2019-11-20 23:02:58 +0100
committerFabian Mastenbroek <mail.fabianm@gmail.com>2019-11-20 23:02:58 +0100
commit254e49e15c47c91336d2af3a0948aa474e62de5f (patch)
tree9a03fa90434adade4cba6d936c7950b9f7bf215e /odcsim
parent6ca0ae07669d20a5a34ef697610df90754024035 (diff)
chore: Tidy repository
Diffstat (limited to 'odcsim')
-rw-r--r--odcsim/README.md17
-rw-r--r--odcsim/docs/build.md1
-rw-r--r--odcsim/docs/concepts.md0
-rw-r--r--odcsim/docs/models.md0
-rw-r--r--odcsim/docs/run.md0
-rw-r--r--odcsim/odcsim-core/build.gradle.kts2
-rw-r--r--odcsim/odcsim-engine-omega/build.gradle.kts2
-rw-r--r--odcsim/odcsim-engine-tests/build.gradle.kts2
8 files changed, 18 insertions, 6 deletions
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
--- /dev/null
+++ b/odcsim/docs/concepts.md
diff --git a/odcsim/docs/models.md b/odcsim/docs/models.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/odcsim/docs/models.md
diff --git a/odcsim/docs/run.md b/odcsim/docs/run.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/odcsim/docs/run.md
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`