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

Format README.md

Browse Source
This commit is contained in:
Joakim Hellsén
2023-01-10 17:14:07 +01:00
parent 792ee18182
commit 9d44ac18bd
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -10,18 +10,18 @@ or [install directly on your computer](#Install-directly-on-your-computer).
### Docker ### Docker
- 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 Show more options - Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and Show more options
and `Open PowerShell window here` 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>.
- If you want to run the bot in the background, you can run `docker-compose up -d`. - If you want to run the bot in the background, you can run `docker-compose up -d`.
- You should run this bot behind a reverse proxy like [Caddy](https://caddyserver.com/) - You should run this bot behind a reverse proxy like [Caddy](https://caddyserver.com/)
or [Nginx](https://www.nginx.com/). or [Nginx](https://www.nginx.com/).
- 5000 is the port the bot listens on. - 5000 is the port the bot listens on.
- You can update the container with `docker-compose pull` - You can update the container with `docker-compose pull`
- You can automate this with [Watchtower](https://github.com/containrrr/watchtower) - You can automate this with [Watchtower](https://github.com/containrrr/watchtower)
or [Diun](https://github.com/crazy-max/diun) or [Diun](https://github.com/crazy-max/diun)
### Install directly on your computer ### Install directly on your computer
@ -29,27 +29,27 @@ or [install directly on your computer](#Install-directly-on-your-computer).
This is not recommended if you don't have an init system (e.g., systemd) This is not recommended if you don't have an init system (e.g., systemd)
- Install the latest version of needed software: - Install the latest version of needed software:
- [Python](https://www.python.org/) - [Python](https://www.python.org/)
- You should use the latest version. - You should use the latest version.
- You want to add Python to your PATH. - You want to add Python to your PATH.
- Windows: Find `App execution aliases` and disable python.exe and python3.exe - Windows: Find `App execution aliases` and disable python.exe and python3.exe
- [Poetry](https://python-poetry.org/docs/master/#installation) - [Poetry](https://python-poetry.org/docs/master/#installation)
- Windows: You have to add `%appdata%\Python\Scripts` to your PATH for Poetry to work. - Windows: You have to add `%appdata%\Python\Scripts` to your PATH for Poetry to work.
- Download the project from GitHub with Git or download - Download the project from GitHub with Git or download
the [ZIP](https://github.com/TheLovinator1/discord-rss-bot/archive/refs/heads/master.zip). the [ZIP](https://github.com/TheLovinator1/discord-rss-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.
- 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 Show more options - Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and Show more options
and `Open PowerShell window here` and `Open PowerShell window here`
- Install requirements: - Install requirements:
- Type `poetry install` into the PowerShell window. Make sure you are - Type `poetry install` into the PowerShell window. Make sure you are
in the repository folder where the [pyproject.toml](pyproject.toml) file is located. in the repository folder where the [pyproject.toml](pyproject.toml) file is located.
- (You may have to restart your terminal if it can't find the `poetry` command. Also double check it is in - (You may have to restart your terminal if it can't find the `poetry` command. Also double check it is in
your PATH.) your PATH.)
- Start the bot: - Start the bot:
- Type `poetry run bot` into the PowerShell window. - Type `poetry run bot` into the PowerShell window.
- You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>. - You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>.
Note: You will need to run `poetry install` again if [poetry.lock](poetry.lock) has been modified. Note: You will need to run `poetry install` again if [poetry.lock](poetry.lock) has been modified.