summaryrefslogtreecommitdiff
path: root/README.md
blob: fa8a0ba945409f1aea806fc45c2f96fd460cf91d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<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>

## Getting the source
Download the source code by running the following code in your command prompt:
```sh
$ git clone https://github.com/atlarge-research/opendc-simulator.git
```
or simply [grab](https://github.com/atlarge-research/opendc-simulator/archive/master.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.