summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authormjkwiatkowski <mati.rewa@gmail.com>2026-02-10 08:14:41 +0100
committermjkwiatkowski <mati.rewa@gmail.com>2026-02-10 08:14:41 +0100
commit4d37bbed4a1f745c331ba996fc860d79e3e51e8f (patch)
tree69d4e530f1f5a5192f98bb422d46618afb291c23 /README
parent7a078fac132d10933e52edafd0f2527c50c9b1b6 (diff)
feat: added the entry point to experiment listenerHEADmaster
Diffstat (limited to 'README')
-rw-r--r--README44
1 files changed, 44 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..8645f74e
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+<a href="https://opendc.org/">
+ <img src="https://opendc.org/img/logo.png" alt="OpenDC logo" title="OpenDC" align="right" height="100" />
+</a>
+
+# OpenDC
+
+Collaborative Datacenter Simulation and Exploration for Everybody
+
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](/LICENSE.txt)
+[![Documentation](https://img.shields.io/badge/docs-master-green.svg)](https://atlarge-research.github.io/opendc)
+[![GitHub release](https://img.shields.io/github/v/release/atlarge-research/opendc?include_prereleases)](https://github.com/atlarge-research/opendc/releases)
+[![Build](https://github.com/atlarge-research/opendc/actions/workflows/build.yml/badge.svg)](https://github.com/atlarge-research/opendc/actions/workflows/build.yml)
+
+-----
+
+This repository is the home of the OpenDC project, a free and open-source platform for cloud datacenter simulation.
+
+## Latest Release
+
+All releases of OpenDC can be found [here](https://github.com/atlarge-research/opendc/releases).
+The latest release will be marked _latest_.
+
+## Documentation
+
+You can find the OpenDC documentation [on the website](https://atlarge-research.github.io/opendc/).
+The documentation is divided into several sections:
+
+* [Getting Started](https://atlarge-research.github.io/opendc/docs/category/getting-started/)
+* [Tutorials](https://atlarge-research.github.io/opendc/docs/category/tutorials/)
+* [Advanced Guides](https://atlarge-research.github.io/opendc/docs/category/advanced-guides/)
+* [Where to Get Support](https://atlarge-research.github.io/opendc/community/support/)
+* [Contributing Guide](https://atlarge-research.github.io/opendc/community/contributing/)
+
+The source code for the documentation is located in the [gh-pages branch](https://github.com/atlarge-research/opendc/tree/gh-pages).
+Push to that branch to update the documentation.
+
+## Contributing
+
+Questions, suggestions and contributions are welcome and appreciated!
+Please refer to the [contributing guidelines](CONTRIBUTING.md) for more details.
+
+## License
+
+OpenDC is distributed under the MIT license. See [LICENSE.txt](/LICENSE.txt).