Update installation guide

See: codeoverflow-org/chatoverflow#63

Author: J0B10

README.md

@@ -19,10 +19,11 @@ For more information about the chat overflow project, please visit [codeoverflow
     2. [Credentials value encrypted with wrong auth key](usage/Frequent-Issues.md#Credentials-value-encrypted-with-wrong-auth-key)  
 
 **Development:**  
-1. [Writing a plugin](development/Writing-a-plugin.md)  
-2. [Adding a new platform source](development/Adding-a-new-platform-source.md)  
-3. [Deploy ChatOverflow](development/Deploy-ChatOverflow.md)
-4. [Structure](development/Structure.md)
+1. [Build Environment](development/Setting-up-the-Build-Environment.md)
+2. [Writing a plugin](development/Writing-a-plugin.md)  
+3. [Adding a new platform source](development/Adding-a-new-platform-source.md)  
+4. [Deploy ChatOverflow](development/Deploy-ChatOverflow.md)
+5. [Structure](development/Structure.md)
 
 **Services:**
 1. [Twitch Chat](services/Twitch-Chat.md)

_Sidebar.md

@@ -14,10 +14,11 @@
     2. [Credentials value encrypted with wrong auth key](usage/Frequent-Issues.md#Credentials-value-encrypted-with-wrong-auth-key)  
 
 **Development:**  
-1. [Writing a plugin](development/Writing-a-plugin.md)  
-2. [Adding a new platform source](development/Adding-a-new-platform-source.md)  
-3. [Deploy ChatOverflow](development/Deploy-ChatOverflow.md)
-4. [Structure](development/Structure.md)
+1. [Build Environment](development/Setting-up-the-Build-Environment.md)
+2. [Writing a plugin](development/Writing-a-plugin.md)  
+3. [Adding a new platform source](development/Adding-a-new-platform-source.md)  
+4. [Deploy ChatOverflow](development/Deploy-ChatOverflow.md)
+5. [Structure](development/Structure.md)
 
 **Services:**
 1. [Twitch Chat](services/Twitch-Chat.md)

development/Setting-up-the-Build-Environment.md

@@ -0,0 +1,38 @@
+This short tutorial is meant for developers and shows how to setup the build environment.  
+If you want to install and run ChatOverflow head over to [Installation](usage/Installation.md).
+
+## Prerequisites
+
+For working on chatoverflow the following tools must be installed on your PC:
+
+* Java 8 version `1.8.0_161` or newer
+* [git - version control system](https://git-scm.com/downloads) 
+* [sbt - Scala build tool](https://www.scala-sbt.org/download.html)
+* [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/get-npm)  - pakage manager
+
+## Windows
+
+1. Save the [📄 install.bat](https://raw.githubusercontent.com/codeoverflow-org/chatoverflow-setup/master/install.bat) to the directory where you want to install the build environment.
+
+2. Execute the script, use the `--dev` argument if you want to check out the development branch automatically.
+
+3. Drink some coffee while the script clones all repositories, sets up sbt and installs the gui.
+
+4. Start developing!
+
+## UNIX operating systems (MacOs / Linux)
+
+1. Save the [📄 install.sh](https://raw.githubusercontent.com/codeoverflow-org/chatoverflow-setup/master/install.sh) to the directory where you want to install the build environment.
+
+2. Execute the script, use the `--dev` argument if you want to check out the development branch automatically.
+
+3. Drink some coffee while the script clones all repositories, sets up sbt and installs the gui.
+
+4. Start developing!
+
+### Alternative
+
+This command downloads the script and executes it: 
+```shell script
+bash <(curl -s https://raw.githubusercontent.com/codeoverflow-org/chatoverflow-setup/master/install.sh)
+```

usage/Installation.md

@@ -1,51 +1,34 @@
-This tutorial shows how to install the chat overflow framework. By now, working with the development environment is the only way. Currently, there are **no builds available.**
+This short tutorial is meant for end users of ChatOverflow and shows how to install and run the framework with all dependencies.  
+If you want to set up a build environment for developing plugins or contributing to the framework,
+head over to [Build Environment](development/Setting-up-the-Build-Environment.md).
 
-### Pro
+## Prerequisites
 
-1. Clone the main repository. Then clone the api into folder `codeoverflow/api`, the gui into folder `codeoverflow/gui` and public plugins repository into `codeoverflow/plugins-public`.
-2. Setup the main repository as imported scala project, e.g. using IntelliJ. Make sure to refresh all sbt content and load the custom run configurations.
-3. You're done. Happy coding!
+For running Chatoverflow you need Java 8, version `1.8.0_161` or newer.  
+[Download it form here.](https://www.java.com/en/download/)
 
-### Not so Pro
+## Windows
 
-0. Download and install [git](https://git-scm.com/) (obviously) and [Node.js](https://nodejs.org/en/download/). Make sure that you can run it using the console.
-1. Clone the main repository using `git clone https://github.com/codeoverflow-org/chatoverflow.git`.
-2. Navigate to the created chatoverflow-folder, e.g. using `cd chatoverflow`.
-3. Clone the [api repository](https://github.com/codeoverflow-org/chatoverflow-api) into a folder named "api". using `git clone https://github.com/codeoverflow-org/chatoverflow-api.git api`.
-4. Clone the [gui repository](https://github.com/codeoverflow-org/chatoverflow-gui) into a folder named "gui". using `git clone https://github.com/codeoverflow-org/chatoverflow-gui.git gui`.
-5. Clone the [public plugins repository](https://github.com/codeoverflow-org/chatoverflow-plugins) into a folder named "plugins-public" using `git clone https://github.com/codeoverflow-org/chatoverflow-plugins.git plugins-public`.
+1. Head over to the [releases](https://github.com/codeoverflow-org/chatoverflow/releases/latest)
+and download the ChatOverflow `.zip` file from the assets section of the latest release.
 
-    Site note: You can name the folders whatever you want. But if you do so, update the names in the main [build-file](https://github.com/codeoverflow-org/chatoverflow/blob/42b9469fe489fe5efeb4aa70f278e3558fccab7d/build.sbt#L64).
+2. Extract the zip file (it's clever to extract it in  a folder called chatoverflow 😉)
 
-6. Open up your most favorite IDE for java (and scala) development. I recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/). There is also a free community version available!
-7. Make sure, IntelliJ IDEA and the scala plugin are up to date. Every time I open this software, a new update is available...
-8. Choose open project and select the freshly cloned `chatoverflow` folder (with the main build.sbt) in it. Make sure, auto-import is NOT enabled.
-9. Click on `Refresh sbt project`. Make sure to use a up-to-date java 1.8 SDK, do not change any other settings in the dialog window.
-10. Wait for 5.2 years. In the background, 3 projects are build, ressources will be downloaded and a lot of magic happens!
-11. When the process finished, you should see the project and its children in the project view. Get to know them (or wait till I introduce them later).
+3. Execute the `ChatOverflow.bat`. 
 
-     Site note: The run configurations contain a lot of sbt commands and presets for plugin development. You will probably never need more. Brief documentation can be found in the main build.sbt file.
+4. Wait for the launcher to download all dependencies ⏳
 
-12. Select the run configuration `Fetch plugins (sbt fetch)` and execute it. A file named `plugins.sbt` should be generated, containing all references to plugins and the api project.
-13. Use sbt reload (the refresh icon in the upper left corner of the sbt window, opened e.g. by View -> Tool Windows -> SBT) to reload the whole project. Now, the child projects should be recognized correctly.
-14. Have a look at the application run configurations. Do they have an red X? Then they are broken. Click on `Edit configurations` and select `root` as module ("Use classpath as module"). Now, they should be happy.
-15. Execute the run configuration `[Advanced] Full Reload and Run ChatOverflow` (and pray). This is only needed for the first startup and when you create a new plugin!
+5. The framework will start. When executing the `ChatOverflow.bat` again it will skipp downloading the dependencies.
 
-     * A lot happens now. First, all target folders and the build environment is cleaned.
-     * Then, the project is freshly build and all plugins are fetched. The plugins.sbt file is generated. Then, the whole build environment is reloaded.
-     * Next, all plugin versions and the api version are printed for debug reasons.
-     * Last, all plugins compiled code is packaged into several .JAR-Archives and copied to the `plugins`-folder.
-     * Everything is set up, and the chat overflow framework is executed. It checks the plugin folder and tries to load the plugins. Done!
+## UNIX operating systems (MacOs / Linux)
 
-     Site note: You do not have to repeat this step after each simple change. There is also a `[Simple]` run configuration for this.
+1. Head over to the [releases](https://github.com/codeoverflow-org/chatoverflow/releases/latest)
+and download the ChatOverflow `.zip` file from the assets section of the latest release.
 
-     Yet another site note: The projects folder structure is realy easy.
+2. Extract the zip file (it's clever to extract it in  a folder called chatoverflow 😉)
 
-     * the api folder contains the API-project with all common chat overflow modelling.
-     * the plugins folder contains packaged plugins. Just leave him alone.
-     * the plugins-public folder contains all official/public chat overflow plugins. Each plugin has its own sub project.
-     * the project folder contains build code for the plugin framework.
-     * the src folder contains the chat overflow framework code.
-     * the target folder contains the build framework.
+3. Execute the `ChatOverflow.sh`. 
 
-16. You're done. Happy coding!
+4. Wait for the launcher to download all dependencies ⏳
+
+5. The framework will start. When executing the `ChatOverflow.sh` again it will skipp downloading the dependencies.