From d609fa439ad29e94013a60acd331e5d723ac3932 Mon Sep 17 00:00:00 2001 From: Brady Pascoe Date: Thu, 26 Apr 2018 23:36:13 -0700 Subject: [PATCH 1/4] Added Setting Up Your Environment --- SETTING-UP-YOUR-ENVIRONMENT.md | 51 ++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 SETTING-UP-YOUR-ENVIRONMENT.md diff --git a/SETTING-UP-YOUR-ENVIRONMENT.md b/SETTING-UP-YOUR-ENVIRONMENT.md new file mode 100644 index 0000000..39edd31 --- /dev/null +++ b/SETTING-UP-YOUR-ENVIRONMENT.md @@ -0,0 +1,51 @@ +# Setting Up Your Environment + +**NOTE** This page assumes you have already read the [Prerequisites](https://github.com/UWB-ACM/DiscordBot_Java#prerequisites) section. + +## Setting up Gradle + +Gradle is a quite simple tool to use, after it is set up properly. In order to check to see if it is properly set up, type into the command line: + + gradle + +The result should be along the lines of: + + > Task :help + + Welcome to Gradle 4.5.1. + + To run a build, run gradle ... + + To see a list of available tasks, run gradle tasks + + To see a list of command-line options, run gradle --help + + To see more detail about a task, run gradle help --task + +**Note** if an error occurs, make sure to add Gradle's file path to the `PATH` variable in your system's environment. If that still doesn't fix the problem, then verify that you installed Gradle correctly. + +Once Gradle is set up, it's time to get a local copy of the repository to your system. + +## Getting a local copy of the repository + +[Fork](https://help.github.com/articles/fork-a-repo/) this repository. + +Open the command line (or terminal in Linux) and find a safe place to put your local copy of the repository. + +Clone the forked repository: + + git clone https://github.com/[YOUR_USERNAME_HERE]/DiscordBot_Java + +## Building the environment + +Open the command line (or terminal in Linux) and navigate to the repository's directory. + +Type in the following command: + + gradle build + +**Optional** If you are using IntelliJ, run the following command: + + gradle idea + +**Note** You might need to import the project as a Gradle project when you open IntelliJ. From acb25f04e6e00a608bf6876ff21b2e6d8edca76a Mon Sep 17 00:00:00 2001 From: Brady Pascoe Date: Thu, 26 Apr 2018 23:38:28 -0700 Subject: [PATCH 2/4] Fixed link in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 40dbd35..600f94e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > A barebones Java-based Discord bot example written using [Discord4J](https://github.com/Discord4J/Discord4J). -For a barbones python-based example, See also [CSSBot_Py](https://github.com/UWB-ACM/CSSBot_Py). +For a barebones python-based example, See also [CSSBot_Py](https://github.com/UWB-ACM/CSSBot_Py). For a full example written in C#, See also [CSSBot](https://github.com/Chris-Johnston/CSSBot). @@ -27,7 +27,7 @@ This repository utilizes [Gradle](https://gradle.org/) in order to automate the ## Setup -**Note** For a detailed description of how to set up your environment with Gradle (for beginners), please see [Setting Up Your Environment](https://github.com/UWB-ACM/DiscordBot_Java/wiki/Setting-Up-Your-Environment). +**Note** For a detailed description of how to set up your environment with Gradle (for beginners), please see [Setting Up Your Environment](https://github.com/UWB-ACM/DiscordBot_Java/SETTING-UP-YOUR-ENVIRONMENT.md). After cloning and forking the repository, run the following command within the local directory: From a5df7f358f7382ce5ab5443ab712aea14ad485b1 Mon Sep 17 00:00:00 2001 From: Brady Pascoe Date: Thu, 26 Apr 2018 23:40:54 -0700 Subject: [PATCH 3/4] Changed link to relative instead of absolute --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 600f94e..7962ee5 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ This repository utilizes [Gradle](https://gradle.org/) in order to automate the ## Setup -**Note** For a detailed description of how to set up your environment with Gradle (for beginners), please see [Setting Up Your Environment](https://github.com/UWB-ACM/DiscordBot_Java/SETTING-UP-YOUR-ENVIRONMENT.md). +**Note** For a detailed description of how to set up your environment with Gradle (for beginners), please see [Setting Up Your Environment](SETTING-UP-YOUR-ENVIRONMENT.md). After cloning and forking the repository, run the following command within the local directory: From fc077a168b5bab87eb291f6a1ebf340e9315d286 Mon Sep 17 00:00:00 2001 From: Brady Pascoe Date: Thu, 26 Apr 2018 23:42:54 -0700 Subject: [PATCH 4/4] Changed absolute link to a relative link --- SETTING-UP-YOUR-ENVIRONMENT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SETTING-UP-YOUR-ENVIRONMENT.md b/SETTING-UP-YOUR-ENVIRONMENT.md index 39edd31..6c027b2 100644 --- a/SETTING-UP-YOUR-ENVIRONMENT.md +++ b/SETTING-UP-YOUR-ENVIRONMENT.md @@ -1,6 +1,6 @@ # Setting Up Your Environment -**NOTE** This page assumes you have already read the [Prerequisites](https://github.com/UWB-ACM/DiscordBot_Java#prerequisites) section. +**NOTE** This page assumes you have already read the [Prerequisites](README.md#prerequisites) section. ## Setting up Gradle