diff options
| author | Georgios Andreadis <info@gandreadis.com> | 2020-06-29 16:04:57 +0200 |
|---|---|---|
| committer | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2020-08-24 16:18:13 +0200 |
| commit | 46b06fb446e79c390c01953d31d700b8e73da24d (patch) | |
| tree | b2329630ebf2c90d297ba0d3046ccd558d12d042 /simulator/README.md | |
| parent | ebcacf96fbc1cd16a91523f95dd01db046fb7f90 (diff) | |
Prepare simulator repository for monorepo
This change prepares the simulator Git repository for the monorepo residing at
https://github.com/atlarge-research.com/opendc. To accomodate for this, we
move all files into a simulator subdirectory.
Diffstat (limited to 'simulator/README.md')
| -rw-r--r-- | simulator/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/simulator/README.md b/simulator/README.md new file mode 100644 index 00000000..1bc866cf --- /dev/null +++ b/simulator/README.md @@ -0,0 +1,46 @@ +<h1 align="center"> + <a href="http://opendc.org/"> + <img src="misc/artwork/logo.png" width="100" alt="OpenDC"> + </a> + <br> + 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> + <a href="https://opensource.org/licenses/MIT"> + <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License"> + </a> +</p> + +## Introduction +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. + +## 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: +1. [Introduction](docs/introduction.md) +1. [Toolchain Setup](docs/setup.md) +2. [Architecture Overview](docs/architecture.md) +3. [Running an Experiment](docs/run.md) + +## Getting Started +TODO + +## Contributing +### Contributing Guide +Read our [contributing guide](CONTRIBUTING.md) to learn about our +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 available under the [MIT license](https://github.com/atlarge-research/opendc-simulator/blob/master/LICENSE.txt). |