Skip to content

Commit

Permalink
docs: 📝 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
strazto committed Jul 12, 2023
1 parent 8ae5370 commit 124d244
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,34 @@ A Discord bot that can transcribe and translate Discord Voice Messages.
- speech recognition
- deepl

Run the following:

```bash
pip install -r requirements.txt
```

## Installation

> **Note**
> Bot requires Intents to be enabled in the developer portal & an API key for the DeepL API.
- Clone the repository: `git clone https://github.com/dromzeh/vmt.git`
- Rename the `config.example.json` file to `config.json` inside `src/config` and fill in the necessary values (See [Configuration](#configuration))
- Run the bot inside the `/src` folder: `python bot.py`

Once the configuration file has been filled, you may run the bot using one of the following methods:

### Native Installation

- Install the requirements `pip install -r requirements.txt`
- Run the bot inside the `/src` folder: `python main.py`

### Docker Installation (Easier)

Assuming `docker` and `docker-compose` are installed

```bash
docker-compose -f compose.yaml up
```

## Usage

Expand Down

0 comments on commit 124d244

Please sign in to comment.