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 /docs/setup.md | |
| parent | 04e4bddccc4e06a126f3c6ee2878502323c7116e (diff) | |
Adapt documentation outline and README
Diffstat (limited to 'docs/setup.md')
| -rw-r--r-- | docs/setup.md | 18 |
1 files changed, 18 insertions, 0 deletions
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) |