From ae21ed49ddd785592a0d0d4ec2a19e7a9f74af3e Mon Sep 17 00:00:00 2001 From: originalmk <30776840+originalmk@users.noreply.github.com> Date: Mon, 27 Mar 2023 21:01:42 +0200 Subject: [PATCH 1/4] Created some nice README! --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..790dbe5 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +![Logo SLG](slg-logo.png) + +# Song Lyrics Generator +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. + +## Authors +- Sebastian Kutny +- Tomasz Lewandowski +- Maciej Kryżanowski From 381466bc50655e243eee6f0895b90444a2abd0c6 Mon Sep 17 00:00:00 2001 From: originalmk <30776840+originalmk@users.noreply.github.com> Date: Mon, 27 Mar 2023 21:05:36 +0200 Subject: [PATCH 2/4] Added run instructions to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 790dbe5..c8dcad1 100644 --- a/README.md +++ b/README.md @@ -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 From 2330f9c1d18ae0aa876e9c808a10e1d5fc790ea8 Mon Sep 17 00:00:00 2001 From: originalmk <30776840+originalmk@users.noreply.github.com> Date: Mon, 27 Mar 2023 21:08:21 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c8dcad1..94be509 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ but it will be expanded to include even recursive neural networks version or the 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". +4. Pick your desired song type from menu :) ## Authors - Sebastian Kutny From ab6de0497df5524f46eb3fdeb9e7e2c050135a7c Mon Sep 17 00:00:00 2001 From: originalmk <30776840+originalmk@users.noreply.github.com> Date: Mon, 27 Mar 2023 21:08:34 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 94be509..2f2a06a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ but it will be expanded to include even recursive neural networks version or the 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". -4. Pick your desired song type from menu :) +4. Pick your desired song type from the menu :) ## Authors - Sebastian Kutny