diff options
| author | Georgios Andreadis <info@gandreadis.com> | 2019-12-20 11:26:33 +0100 |
|---|---|---|
| committer | Georgios Andreadis <info@gandreadis.com> | 2020-02-14 19:14:31 +0100 |
| commit | b593268b50784964c672f8b5aaa857e9b9243634 (patch) | |
| tree | 3f98954f001c7ae559aa89217ee0a977400c6476 /README.md | |
| parent | 04e4bddccc4e06a126f3c6ee2878502323c7116e (diff) | |
Adapt documentation outline and README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -24,6 +24,17 @@ 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. [Toolchain Setup](docs/setup.md) +2. [Architecture Overview](docs/architecture.md) +3. [Pre-built Models](docs/models.md) +4. [Running a Model](docs/run.md) +5. [Building Your Own Model](docs/build.md) +6. [API Reference](https://atlarge-research.github.io/opendc-simulator) **(TODO maybe remove this until we have created this - see #36)** + ## Contributing ### Contributing Guide Read our [contributing guide](CONTRIBUTING.md) to learn about our |