diff --git a/README.md b/README.md index 179f310..5a178dc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ -# os-release-bot +# /ETC/OS-RELEASE -A bot written for the Linux General Discord Server \ No newline at end of file +A bot written for the Linux General Discord Server + +### How to run + +- Install the necessary packages: +```sh +pip install -r requirements.txt +``` + +- On the last line, replace `TOKEN` with your bot token + +- Then, run the `main.py`file: +```sh +python3 main.py +``` + + +### WARNING! + +As this bot is made for one discord server, most things on it are hardcoded. +For this bot to work, you might need to replace a big part of the code. + +Any use of this bot outside of Linux General is not mine and Bodge's responsability. \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1f86944 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +discord.py==2.1.0 +psutil==5.9.4