Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: README.md improvements: clarify testing, add additional docker information #333

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Docs: README.md improvements: clarify testing, add additional docker information #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
# Getting Started

**Prerequisites (MUST):**

- [Python 2.7+](https://www.python.org/downloads/)
- [Node.js 23.1+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [pnpm](https://pnpm.io/installation)
Expand Down Expand Up @@ -160,7 +160,7 @@ For help with setting up your Discord Bot, check out here: https://discordjs.gui

## Testing

To run the test suite:
To run the test suite, you must got into each package:

```bash
pnpm test # Run tests once
Expand Down Expand Up @@ -190,3 +190,7 @@ For development purposes, you can run the docker container with the following co
```
pnpm docker
```

This will drop you into a shell inside the docker container where you can continue to configure the instance

and then you can start it with `pnpm start`