Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added acknowledgements and fixed Manual configurations
  • Loading branch information
stef1949 authored Jul 29, 2024
1 parent 09407d9 commit f2395f8
Showing 1 changed file with 37 additions and 6 deletions.
43 changes: 37 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ chmod +x setup.sh
setup.bat
```

## Configuration
## Manual Configuration
### 1. Create a Discord Bot
- Go to the Discord Developer Portal.
- Create a new application.
Expand All @@ -80,26 +80,57 @@ setup.bat
### 2. Create a '.env' File
Create a .env file in the root directory of the project and add your Discord bot token:
```env
DISCORD_BOT_TOKEN=your_discord_bot_token_here
BOT_TOKEN=your_discord_bot_token_here
```
## Usage
### 1. Activate the Virtual Environment
### 1. Create Virtual Environment
On Unix-based systems:
```bash
source myenv/bin/activate
conda create -n discordbot python -y
```
On Windows systems:
```bash
call myenv\Scripts\activate
conda create -n discordbot python -y
```

### 2. Run the Bot
### 2. Activate the Virtual Environment
On Unix-based systems:
```bash
source activate discordbot
```
On Windows systems:
```bash
conda activate discordbot
```

### 3. Run the Bot
```bash
python bot.py
```

## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

## Acknowledgements

We would like to express our gratitude to the following individuals, libraries, and resources that have made this project possible:

### Libraries and Tools
- **discord.py**: An essential library for interacting with the Discord API. Without this robust library, the development of this bot would not have been possible.
- **whisperx**: For providing the speech recognition model used in the bot to transcribe audio messages.
- **pydub**: A fantastic library for audio processing, enabling seamless conversion and handling of audio files within the bot.
- **python-dotenv**: For simplifying the management of environment variables in the project.

### Platforms
- **Conda**: For providing a powerful package management and environment management system that made handling dependencies straightforward and efficient.

### Open Source Community
We extend our sincere thanks to the open-source community for their continuous contributions to libraries and tools that make projects like this possible.

### Inspiration and Support
- **GitHub**: For offering a collaborative platform for code sharing and project management.

Thank you all for your support and contributions!

## License
This project is licensed under the MIT License.

0 comments on commit f2395f8

Please sign in to comment.