From 34e427caf873c7498e8f8e8811a3bc93a98516b8 Mon Sep 17 00:00:00 2001 From: JRoshthen1 <37882816+JRoshthen1@users.noreply.github.com> Date: Thu, 25 Apr 2024 20:36:45 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 045257c..81e3ad9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ pip 24.0 ### Running Locally - Clone the repository: +Clone the repository: ```bash git clone https://github.com/yourusername/LectureSummarizer.git @@ -26,7 +26,7 @@ cd LectureSummarizer/ Install dependencies: ```bash - pip install -r requirements.txt +pip install -r requirements.txt ``` ## Usage @@ -35,7 +35,7 @@ Install dependencies: ## Contributing -- Start by forking the repository and then clone your fork. +- Start by forking the repository. - Create a branch in your fork for your contributions. - Commit your changes with clear commit messages. - Push your branch to your fork on GitHub and submit a pull request to the main project. From d04390049b475a06809fe9a5c8e03721c0c11830 Mon Sep 17 00:00:00 2001 From: JRoshthen1 <37882816+JRoshthen1@users.noreply.github.com> Date: Thu, 25 Apr 2024 20:44:08 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 81e3ad9..b450c15 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ -# Project Name +# Lecture Summarizer ## Description - -Brief description of the project. +Tkinter application to record text with openai-whisper, extract keyword from transcription with sklearn's TF-IDF and generate notes with gguf llm model ## Requirements - Python 3.10.12 pip 24.0 @@ -16,7 +14,7 @@ pip 24.0 Clone the repository: ```bash -git clone https://github.com/yourusername/LectureSummarizer.git +git clone https://github.com/JRoshthen1/LectureSummarizer.git ``` Navigate to the project directory: