TheLovinator/discord-reminder-bot
1
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Joakim Hellsén
2022-01-31 23:00:48 +01:00
parent ce588b10fa
commit e5bcfcc560
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -28,7 +28,14 @@ You have two choices, [install directly on your computer](#Install-directly-on-y
### Install directly on your computer ### Install directly on your computer
- Install latest version of [git](https://git-scm.com/), [Python](https://www.python.org/) and [Poetry](https://python-poetry.org/docs/master/#installation). - Install latest version of needed software:
- [git](https://git-scm.com/)
- Default installation is fine.
- [Python](https://www.python.org/)
- You should use the latest version.
- You want to add Python to your PATH.
- [Poetry](https://python-poetry.org/docs/master/#installation)
- Windows: You have to add `\AppData\Roaming\Python\Scripts` to your PATH for Poetry to work.
- Download project from GitHub with git or download the [ZIP](https://github.com/TheLovinator1/discord-reminder-bot/archive/refs/heads/master.zip). - Download project from GitHub with git or download the [ZIP](https://github.com/TheLovinator1/discord-reminder-bot/archive/refs/heads/master.zip).
- If you want to update the bot, you can run `git pull` in the project folder or download the ZIP again. - If you want to update the bot, you can run `git pull` in the project folder or download the ZIP again.
- Rename .env.example to .env and open it in a text editor. - Rename .env.example to .env and open it in a text editor.
@ -37,7 +44,7 @@ You have two choices, [install directly on your computer](#Install-directly-on-y
- Windows 11: Click View -> Show -> File name extensions. - Windows 11: Click View -> Show -> File name extensions.
- Open a terminal in the repository folder. - Open a terminal in the repository folder.
- Windows 10: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here` - Windows 10: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here`
- Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open in Windows Terminal` - Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and Show more options and `Open PowerShell window here`
- Install requirements: - Install requirements:
- `poetry install` - `poetry install`
- (You may have to restart your terminal if it can't find the `poetry` command) - (You may have to restart your terminal if it can't find the `poetry` command)
@ -60,7 +67,7 @@ Docker Hub: [thelovinator/discord-reminder-bot](https://hub.docker.com/r/thelovi
- Windows 11: Click View -> Show -> File name extensions. - Windows 11: Click View -> Show -> File name extensions.
- Open a terminal in the extras folder. - Open a terminal in the extras folder.
- Windows 10: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here` - Windows 10: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here`
- Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open in Windows Terminal` - Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and Show more options and `Open PowerShell window here`
- Run the Docker Compose file: - Run the Docker Compose file:
- `docker-compose up` - `docker-compose up`
- You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>. - You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>.