유병우

Add description for installation of readme.md

...@@ -2,6 +2,10 @@ ...@@ -2,6 +2,10 @@
2 2
3 최근 유행하는 Smilegate 사의 로스트아크에 관한 유틸리티와 정보들을 제공하는 디스코드 봇입니다. 3 최근 유행하는 Smilegate 사의 로스트아크에 관한 유틸리티와 정보들을 제공하는 디스코드 봇입니다.
4 4
5 +<img src="./readme_logo.jpg" width="300" height="300">
6 +
7 +
8 +
5 ## About the Project 9 ## About the Project
6 10
7 ### Project motivation 11 ### Project motivation
...@@ -24,11 +28,54 @@ ...@@ -24,11 +28,54 @@
24 28
25 ### Invitation Bot 29 ### Invitation Bot
26 30
27 -[**로스트아크 디스코드 봇 초대하기**](https://discord.com/api/oauth2/authorize?client_id=951774447977771068&permissions=8&scope=bot) 31 +[**로스트아크 디스코드 봇 초대하기**](https://discord.com/api/oauth2/authorize?client_id=951774447977771068&permissions=0&scope=applications.commands%20bot)
28 32
29 위의 링크를 클릭 후 원하는 디스코드 서버를 선택하고 **계속하기**를 누르면 봇을 서버에 초대할 수 있습니다. 33 위의 링크를 클릭 후 원하는 디스코드 서버를 선택하고 **계속하기**를 누르면 봇을 서버에 초대할 수 있습니다.
30 34
31 -![readme_invite](./readme_invite.png) 35 +<img src="./readme_invite.png" width="50%" height="50%">
36 +
37 +### Installation (For contributor)
38 +
39 +**복사를 3번 하므로 메모장이나 텍스트를 저장할 프로그램을 실행해주세요**
40 +
41 +* 해당 링크에서 디스코드 봇 Application을 생성합니다. [Discord Developer](https://discord.com/developers/applications)
42 +
43 +​ New Application - 봇 이름 설정 - Create (봇 이름은 Unique하게 설정해주세요)
44 +
45 +* General Information 카테고리에서 Application ID를 복사합니다.
46 +
47 +<img src="./readme_inst7.png" width="100%" height="100%">
48 +
49 +* SELECTED APP에서 생성한 봇을 선택하고 Bot카테고리 - Build-A-Bot에서 Add Bot을 합니다.
50 +
51 +<img src="./readme_inst3.png" width="100%" height="100%">
52 +
53 +* Reset Token을 통해 봇의 Token을 발급합니다.
54 +
55 +<img src="./readme_inst4.png" width="100%" height="100%">
56 +
57 +* 봇의 Token을 복사합니다.
58 +
59 +<img src="./readme_inst5.png" width="100%" height="100%">
60 +
61 +* 봇을 테스트할 디스코드 테스트서버를 생성합니다.
62 +
63 +* 디스코드서버의 ID를 복사합니다. (서버 우클릭 후 ID 복사)
64 +
65 +<img src="./readme_inst1.png" width="50%" height="50%">
66 +
67 +p.s. ID복사하기 버튼이 보이지 않는다면 디스코드 개인 프로필의 설정(톱니바퀴)-고급-개발자 모드를 ON 합니다.
68 +
69 +<img src="./readme_inst2.png" width="100%" height="100%">
70 +
71 +* config.json의 데이터에 복사한 값을 넣습니다.
72 +
73 +<img src="./readme_inst6.png" width="100%" height="100%">
74 +
75 +p.s. clientId는 첫 번째로 복사한 Application ID, token은 두 번째로 복사한 Bot의 Token,
76 + guildIds는 세 번째로 복사한 디스코드 서버의 ID입니다.
77 +
78 +* 이후 deploy-commands.js를 한 번 실행해주면 Slash command 개발이 준비가 완료됩니다.
32 79
33 ## Usage 80 ## Usage
34 81
...@@ -50,7 +97,29 @@ ...@@ -50,7 +97,29 @@
50 97
51 **/경매 <시세> <인원>** 최적의 경매금 입찰가를 계산합니다. 98 **/경매 <시세> <인원>** 최적의 경매금 입찰가를 계산합니다.
52 99
100 +## Contributing
101 +
102 +1. 해당 Repository를 fork 합니다.
103 +
104 +```git fork http://khuhub.khu.ac.kr/2019102200/lostark-discord-bot.git ```
105 +
106 +2. 본인의 프로젝트로 fork된 Repository를 clone 합니다.
107 +
108 +```git clone http://khuhub.khu.ac.kr/YOUR_ID/lostark-discord-bot.git```
109 +
110 +3. 새로운 기능에 해당하는 feature branch를 만듭니다.
111 +
112 +```git checkout -b feature/NEW_FEATURE```
113 +
114 +4. 기능을 만들어 commit합니다.
115 +
116 +```git commit -m "Update new feature"```
117 +
118 +5. 기능을 다 만들었다면 push합니다.
119 +
120 +```git push origin feature/NEW_FEATURE```
53 121
122 +6. pull request를 합니다.
54 123
55 ## License 124 ## License
56 125
......