Skip to content

Commit

Permalink
docs(readme): Updating
Browse files Browse the repository at this point in the history
  • Loading branch information
Okaneeee committed Oct 21, 2024
1 parent 46d1044 commit 3f2dcf2
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Updating](#updating)
- [Commands](#commands)
- [Long-Term Support (LTS)](#long-term-support-lts)
- [As the developer](#as-the-developer)
Expand Down Expand Up @@ -48,7 +49,7 @@
- Extract the zip file to the directory where you want to clone the repo. Or in Linux:
```bash
sudo apt-get install unzip
unzip SWCodes-main.zip
sudo unzip SWCodes-main.zip -d SWCodes
```
- Open a terminal in the folder where you extracted the zip file and run the following command:
```bash
Expand Down Expand Up @@ -97,6 +98,27 @@ Finally, you can run the bot by running the following command:
python src/main.py
```
### Updating
If you cloned the repo when you did the installation, you can update the repo by running the following command:
```bash
git pull
```
If you downloaded the repo as a zip file, you can download the new version by following the same installation steps you did before. <br>
After, unzip the file using the following command in the same directory as the zip file:
```bash
sudo unzip SWCodes-main.zip -d SWCodes
```
and type `A` to replace all the files. <br>
Finally, you can run the bot again by doing:
```bash
cd SWCodes
python src/main.py
```
## Commands
- `/help`
> Shows the help message with all the commands listed.
Expand Down

0 comments on commit 3f2dcf2

Please sign in to comment.