diff options
| author | Georgios Andreadis <g.andreadis@student.tudelft.nl> | 2020-02-18 21:22:11 +0100 |
|---|---|---|
| committer | Georgios Andreadis <g.andreadis@student.tudelft.nl> | 2020-02-18 21:22:11 +0100 |
| commit | d5070958bbc1e4e644a43b8476ba3662139a8206 (patch) | |
| tree | 4c8fef5c8ac212c54a4d90e2f6c405c853e81bac /README.md | |
| parent | 04e4bddccc4e06a126f3c6ee2878502323c7116e (diff) | |
| parent | f334239b072855561ee522d70d78d8b61e1b6474 (diff) | |
Merge branch 'documentation/extension' into 'feat/2.x'
Write up basic documentation on architecture and toolchain
Closes #25
See merge request opendc/opendc-simulator!24
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 13 insertions, 1 deletions
@@ -24,10 +24,22 @@ This repository hosts the source code and development of the simulation componen - **[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 +development process, how to propose bug fixes and improvements, and how to build and test your changes to the project. ### License |