Skip to content

Commit 99b83d0

Browse files
committed
update readme accordingly
1 parent 7088d7f commit 99b83d0

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,27 @@ saving time.
2323
## Setup
2424

2525
###### Setup a [venv](https://docs.python.org/3/library/venv.html) (optional, but recommend)
26-
`python3 -m venv venv`
27-
`source venv/bin/activate`
28-
29-
30-
##### Using pip to install the bot as editable package:
31-
` python3 -m pip install -e .`
32-
`export TOKEN="your-key"`
33-
`discord-bot`
34-
##### Or using the launch script:
35-
`pip install -r requirements.txt`
36-
`export TOKEN="your-key"`
37-
`python3 ~/git/discord-bot/launcher.py`
26+
```bash
27+
python3 -m venv venv
28+
source venv/bin/activate
29+
```
30+
31+
32+
##### Using pip to install and run the bot as (editable) package:
33+
```bash
34+
python3 -m pip install -e .
35+
export TOKEN="your-token"
36+
discord-bot
37+
```
38+
Note: `-e` is meant only for development. Do not use it for deployment!
39+
40+
##### Or run the bot directly:
41+
```bash
42+
pip install -r requirements.txt
43+
export TOKEN="your-token"
44+
python3 src/discord_bot/__init__.py
45+
```
46+
3847

3948
### Intents
4049
The bot uses all intents by default, those are required for such simple things like 'display member-count at startup'.

0 commit comments

Comments
 (0)