diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..093837c --- /dev/null +++ b/.env.example @@ -0,0 +1,11 @@ +DATABASE_URL= +DATABASE_NAME= + +BOT_TOKEN= +BOT_PREFIX= +BOT_OWNER_ID= + +# If you need +PREVIOUS_DATABASE_URL= + +TRAIN_USER_ID= \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b83ff8e --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# muffinBot + +- 이 프로젝트는 한 Discord 서버에서 내수용으로 사용할려고 만든 Discord상에서 사용가능한 봇입니다. + +## 사용법 + +- 이 프로젝트는 [Go](https://go.dev)언어를 사용하여 만들어졌습니다. + +### 설정 파일 + +- 이 프로젝트는 설정파일을 프로젝트 루트에 있는 `.env`으로 하며, 그 내용은 `.env.example`에서 확인할 수 있습니다. + +## 실행 + +```sh +go run main.go +``` + +### 빌드 + +1. 빌드 + +```sh +go build -o ./build/goMuffin git.wh64.net/muffin/goMuffin # 윈도우면 ./build/goMuffin을 .\build\goMuffin.exe으로 변경 +``` + +2. 실행 + +```sh +./build/goMuffin # 윈도우면 .\build\goMuffin.exe으로 +```