Skip to content

Commit d3fa6e5

Browse files
Improved the read me
1 parent c6f0fc4 commit d3fa6e5

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
# Programmin
2-
The Programming server's Discord bot
1+
[![Java CI with Gradle](https://github.com/Programming-Org/Programming/actions/workflows/gradle.yml/badge.svg)](https://github.com/YusufsDiscordbot/Yusuf-s-Moderation-Bot/actions/workflows/gradle.yml)
2+
[![Spotless](https://github.com/Programming-Org/Programming/actions/workflows/basic-checks.yml/badge.svg)](https://github.com/YusufsDiscordbot/Yusuf-s-Moderation-Bot/actions/workflows/basic-checks.yml)
3+
4+
5+
# Welcome to the Programming Server's Discord bot!
6+
7+
## Before you start
8+
Make sure you have a good knowledge of java and know how [JDA](https://github.com/DV8FromTheWorld/JDA/) works.
9+
10+
Also read the [Code of conduct](https://github.com/Programming-Org/Programming/blob/main/.github/CODE_OF_CONDUCT.md).
11+
12+
And finally do not forget to have a look at the [Example Command](https://github.com/Programming-Org/Programming/blob/main/src/main/java/io/github/org/programming/commands/ExampleCommand.java) to get an idea of how your command should be structured.
13+
## Getting Started
14+
15+
### Part 1
16+
To get started, you'll need to create a Discord bot account and get a token.
17+
18+
1. Go to https://discord.com/developers/applications
19+
2. Click on the **New Application** button
20+
3. Create a name
21+
4. Click on the **Bot** tab
22+
5. Give the bot a name
23+
6. After that go to **OAuth2** tab
24+
7. click **URL Generator**
25+
8. Select bot and applications.commands
26+
9. Select the needed permissions
27+
10. Copy the url and add the bot to your server
28+
11. For the token go back to the bot tab and copy the Token.
29+
12. See part 2
30+
31+
### Part 2
32+
Once you have added the bot to your server, you will need to create a .env file as seen here.
33+
```env
34+
token=
35+
guildId=
36+
ownerId=
37+
```
38+
39+
### Part 3
40+
41+
In order to make a command for the bot, you will need to create an issue and wait to see if the command is needed.
42+
43+
If it is then you will be assigned to the issue, and you can begin making the command.
44+
45+
Once you have made a command, you will need to create a pr on which you will be assigned and the team will review the code and see if it meets the standards.
46+
47+
If it does it will be merged immediately, if not you will be told what to change.
48+
49+
Copyright (C) 2022 - present, Programming Org
50+

0 commit comments

Comments
 (0)