diff options
| -rw-r--r-- | README.md | 11 | ||||
| -rw-r--r-- | docs/architecture.md | 4 | ||||
| -rw-r--r-- | docs/models.md | 4 | ||||
| -rw-r--r-- | docs/run.md | 4 | ||||
| -rw-r--r-- | docs/setup.md | 18 | ||||
| -rw-r--r-- | odcsim/docs/build.md | 5 |
6 files changed, 45 insertions, 1 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 diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 00000000..d26a8749 --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,4 @@ +# 2. Architecture Overview + +--- +[< Previous](setup.md) | [Next >](models.md) diff --git a/docs/models.md b/docs/models.md new file mode 100644 index 00000000..447f50b7 --- /dev/null +++ b/docs/models.md @@ -0,0 +1,4 @@ +# 2. Architecture Overview + +--- +[< Previous](architecture.md) | [Next >](models.md) diff --git a/docs/run.md b/docs/run.md new file mode 100644 index 00000000..c6e26bc7 --- /dev/null +++ b/docs/run.md @@ -0,0 +1,4 @@ +# 4. Running a Model + +--- +[< Previous](models.md) | [Next >](build.md) diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 00000000..f7ab9f12 --- /dev/null +++ b/docs/setup.md @@ -0,0 +1,18 @@ +# 1. Toolchain Setup + +**TODO: Introduction: What basic libraries/language(s) do we use, with links to their respective sites. What tool do we recommend (IDEA probably). Explain that we will now give two alternative ways (IDEA and shell).** + +## Installing Java + +**TODO: Explain which version they need and where they can get it.** + +## Setup With IntelliJ IDEA + +**TODO: Take the user from not having IDEA to having the opendc-simulator codebase open in the environment. Finish with running a test to see if it works.** + +## Setup With Shell + +**TODO: Take the user from not having the codebase to having it and having all dependencies fetched with Gradle. This will likely need separate instructions for Windows and for Linux/MacOS. Advise maybe VS Code as editor to view things after installation. Finish with running a test to see if it works.** + +--- +[Next >](architecture.md) diff --git a/odcsim/docs/build.md b/odcsim/docs/build.md index f442e70b..761fb71a 100644 --- a/odcsim/docs/build.md +++ b/odcsim/docs/build.md @@ -1 +1,4 @@ -# Building a Simulation Model +# Building Your Own Model + +--- +[< Previous](run.md) |