Skip to content
This repository has been archived by the owner on Apr 5, 2019. It is now read-only.

Migrated "Setting Up Your Environment" article #5

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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](SETTING-UP-YOUR-ENVIRONMENT.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested it and it does work, does the link not work for you?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure if it would, but if it does, cool


After cloning and forking the repository, run the following command within the local directory:

Expand Down
51 changes: 51 additions & 0 deletions SETTING-UP-YOUR-ENVIRONMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Setting Up Your Environment

**NOTE** This page assumes you have already read the [Prerequisites](README.md#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 <task> ...

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 <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.