From e5bcfcc560840db3e098e5388479820d64f9a48b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Hells=C3=A9n?= Date: Mon, 31 Jan 2022 23:00:48 +0100 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7253abf..5a59cd4 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,14 @@ You have two choices, [install directly on your computer](#Install-directly-on-y ### 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). - 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. @@ -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. - Open a terminal in the repository folder. - Windows 10: Shift + right-click in the folder and select `Open PowerShell window here` - - Windows 11: Shift + right-click in the folder and select `Open in Windows Terminal` + - Windows 11: Shift + right-click in the folder and Show more options and `Open PowerShell window here` - Install requirements: - `poetry install` - (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. - Open a terminal in the extras folder. - Windows 10: Shift + right-click in the folder and select `Open PowerShell window here` - - Windows 11: Shift + right-click in the folder and select `Open in Windows Terminal` + - Windows 11: Shift + right-click in the folder and Show more options and `Open PowerShell window here` - Run the Docker Compose file: - `docker-compose up` - You can stop the bot with Ctrl + c.