From b593268b50784964c672f8b5aaa857e9b9243634 Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 20 Dec 2019 11:26:33 +0100 Subject: Adapt documentation outline and README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index d3cae15f..68feccc9 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3 From f33cfe79358c31cc786fdb1594cb1c40ab8e0a7b Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 14 Feb 2020 11:37:32 +0100 Subject: Get first two parts of docs up to date and remove odcsim doc --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 68feccc9..1bc866cf 100644 --- a/README.md +++ b/README.md @@ -27,18 +27,19 @@ This repository hosts the source code and development of the simulation componen ## 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: +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. [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)** +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 -- cgit v1.2.3