From b593268b50784964c672f8b5aaa857e9b9243634 Mon Sep 17 00:00:00 2001
From: Georgios Andreadis <info@gandreadis.com>
Date: Fri, 20 Dec 2019 11:26:33 +0100
Subject: Adapt documentation outline and README

---
 docs/architecture.md |  4 ++++
 docs/models.md       |  4 ++++
 docs/run.md          |  4 ++++
 docs/setup.md        | 18 ++++++++++++++++++
 4 files changed, 30 insertions(+)
 create mode 100644 docs/architecture.md
 create mode 100644 docs/models.md
 create mode 100644 docs/run.md
 create mode 100644 docs/setup.md

(limited to 'docs')

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)
-- 
cgit v1.2.3