Added run instructions to README

This commit is contained in:
originalmk 2023-03-27 21:05:36 +02:00 committed by GitHub
parent ae21ed49dd
commit 381466bc50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,6 +4,11 @@
AI-based song lyrics generator trained on data scraped from AZ Lyrics, Tekstowo and others. The generator is currently based on simple Markov chain,
but it will be expanded to include even recursive neural networks version or the chain modifications.
## How to run?
1. Execute `pip3 install -r requirements.txt` to install all dependencies.
2. Open Python shell (just `python3` command) and enter `nltk.download("punkt")`.
3. Run `python3 main.py`, then select "Prepare data".
## Authors
- Sebastian Kutny
- Tomasz Lewandowski