Skip to content

Commit a570e25

Browse files
committed
Update the readme to reflect new project dependencies
1 parent 40a2071 commit a570e25

1 file changed

Lines changed: 8 additions & 20 deletions

File tree

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ To get a bot token go to [Discord Developer Portal](https://discord.com/develope
2626

2727
6. Get your AoC session cookie, see how - https://github.com/wimglenn/advent-of-code-wim/issues/1
2828

29-
7. Create a file `bot.env` in the root project directory and fill it out using the example below
29+
7. Create a file `.env` in the root project directory and fill it out using the example below
3030

31-
8. `docker-compose pull bot`
31+
8. `docker compose pull bot`
3232

33-
9. `docker-compose up --build -d`
33+
9. `docker compose up --build -d`
3434

3535
```text
36-
# bot.env
36+
# .env
3737
3838
FRIENDO_TOKEN = <your token here>
3939
MEME_USERNAME = <your imgflip api username>
@@ -57,24 +57,12 @@ the above environment variables must be added to the system or a file named `.en
5757
# Clone the repository on the develop branch
5858
$ git clone -b "develop" https://github.com/fisher60/friendo-bot.git
5959

60-
# Navigate to the repository directory
61-
$ cd friendo-bot
62-
63-
# Install pipenv through pip or your package manager
64-
$ pip install pipenv
65-
66-
# Install the development and project dependencies
67-
$ pipenv sync --dev
68-
69-
# Install pre-commit hooks
70-
$ pipenv run pre-commit install
60+
# Create a .venv & install dependencies using the make target
61+
$ make
7162

7263
# Optionally: run pre-commit hooks to initialize them
73-
$ pipenv run pre-commit run --all-files
74-
75-
# Enter the pipenv shell
76-
$ pipenv shell
64+
$ make lint
7765

7866
# Run the bot
79-
$ pipenv run python -m bot
67+
$ uv run python -m bot
8068
```

0 commit comments

Comments
 (0)