Merge branch '6-readme' into 'develop'

Add README

Closes #6

See merge request ekzyis/musicube!2
This commit is contained in:
Ramdip Gill 2021-09-24 19:14:15 +00:00
commit 706048c100
1 changed files with 36 additions and 0 deletions

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# musicube
### Development
Requirements:
```
$ python --version
3.9.7
```
Configure virtual environment:
```
$ python -m venv venv
$ source venv/bin/activate
```
Install requirements:
```
$ pip install -r requirements.txt
```
Configure ENV:
```
$ cp .env.template .env
# Write BOT_TOKEN into .env
```
Run bot:
```
$ python src/bot.py
```