diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 7 insertions, 6 deletions
@@ -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 |