summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFabian Mastenbroek <mail.fabianm@gmail.com>2019-11-21 14:36:02 +0100
committerFabian Mastenbroek <mail.fabianm@gmail.com>2019-11-21 14:36:02 +0100
commit17bb0205c577720ab5137729d619b1f3cc71297e (patch)
tree2c800636fff4469faac5b9cceca0bf54751d8172 /README.md
parent4326c2ee0e50a6ba6cfd9bb8258a015aa7c6adf3 (diff)
docs: Move odcsim docs to separate directory
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 10 insertions, 23 deletions
diff --git a/README.md b/README.md
index b4da4287..d3cae15f 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,12 @@
<img src="misc/artwork/logo.png" width="100" alt="OpenDC">
</a>
<br>
- OpenDC
+ OpenDC Simulator
</h1>
<p align="center">
+Collaborative Datacenter Simulation and Exploration for Everybody
+</p>
+<p align="center">
<a href="https://travis-ci.org/atlarge-research/opendc-simulator">
<img src="https://travis-ci.org/atlarge-research/opendc-simulator.svg?branch=master" alt="Build Status">
</a>
@@ -13,29 +16,13 @@
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License">
</a>
</p>
-<p align="center">
- Collaborative Datacenter Simulation and Exploration for Everybody
-</p>
-
## Introduction
-**odcsim** is a framework for discrete event simulation in Kotlin and Java, used
-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 very similar to [Akka Typed](https://doc.akka.io/docs/akka/current/typed/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)
-* [Pre-built Models](docs/models.md)
-* [API Reference](https://atlarge-research.github.io/opendc-simulator)
-* [Contributing Guide](CONTRIBUTING.md)
+This repository hosts the source code and development of the simulation component of the [OpenDC](https://opendc.org) project. This component is responsible for modelling and simulation of datacenters and their components. We have structured the repository into two individual subprojects:
+- **[odcsim](/odcsim)**
+ A framework for discrete event simulation using the [Kotlin](https://kotlinlang.org/) language.
+- **[opendc](/opendc)**
+ A collection of models for simulating clouds, datacenters and their components using the **odcsim** framework.
## Contributing
### Contributing Guide
@@ -44,4 +31,4 @@ development process, how to propose bug fixes and improvements, and how
to build and test your changes to the project.
### License
-The OpenDC simulator is [MIT licensed](https://github.com/atlarge-research/opendc-simulator/blob/master/LICENSE.txt).
+The OpenDC simulator is available under the [MIT license](https://github.com/atlarge-research/opendc-simulator/blob/master/LICENSE.txt).