chore: add readme and requirements

This commit is contained in:
Soumt Nam 2023-09-08 11:03:14 +09:00
parent 6835bf8fb0
commit 38ac3eb2da
2 changed files with 32 additions and 0 deletions

27
readme.md Normal file
View file

@ -0,0 +1,27 @@
# Minya
A module-based misskey bot platform on python.
Example modules (for Korean) included
## install
Clone this repo and install requirements.
```bash
git clone https://git.hawawa.tech/soumt/minya-bot.git
cd minya-bot
pip install -r requirements.txt
```
Copy example.env to .env and modify settings.
```bash
cp example.env .env
vi .env
```
Run minya.
```bash
python3 minya.py
```

5
requirements.txt Normal file
View file

@ -0,0 +1,5 @@
aiohttp~=3.8.4
mipa~=0.3.0
mipac~=0.5.0
pyfiglet~=0.8.post1
python-dotenv~=1.0.0