From a1bf0b6c4255ab60800dcef452a47d0effe94c5a Mon Sep 17 00:00:00 2001
From: Fabian Mastenbroek <mail.fabianm@gmail.com>
Date: Sat, 22 Jul 2017 16:58:59 +0200
Subject: Create basic README for the project

This change adds a basic README for the project in the repository. This
README should be further extended by listing the features supported by
the simulator and instructions on how to run a simulation.
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..a0928d97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+<p align="center">
+  <img src="https://opendc.ewi.tudelft.nl/img/logo.png" width="100" alt="OpenDC Simulator">
+</p>
+<h1 align="center">OpenDC</h1>
+<p align="center">
+Collaborative Datacenter Simulation and Exploration for Everybody
+</p>
+
+## Getting the source
+Download the source code by running the following code in your command prompt:
+```sh
+$ git clone -b kotlin https://github.com/atlarge-research/opendc-simulator.git
+```
+or simply [grab](https://github.com/atlarge-research/opendc-simulator/archive/kotlin.zip) a copy of the source code as a Zip file.
+
+## Building
+For building the source code, we use Gradle. To run gradle, enter the following
+in your command prompt:
+```sh
+$ ./gradlew build
+```
+To test the source code, run the following code in your command prompt
+```
+$ ./gradlew test
+```
+
+## License
+The code is released under the MIT license. See the `LICENSE.txt` file.
-- 
cgit v1.2.3