Merge branch 'main' of https://github.com/JRoshthen1/LectureSummarizer into main
This commit is contained in:
commit
ee19d52cb7
1 changed files with 6 additions and 8 deletions
10
README.md
10
README.md
|
|
@ -1,11 +1,9 @@
|
||||||
# Project Name
|
# Lecture Summarizer
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
Tkinter application to record text with openai-whisper, extract keyword from transcription with sklearn's TF-IDF and generate notes with gguf llm model
|
||||||
Brief description of the project.
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
Python 3.10.12
|
Python 3.10.12
|
||||||
pip 24.0
|
pip 24.0
|
||||||
|
|
||||||
|
|
@ -16,7 +14,7 @@ pip 24.0
|
||||||
Clone the repository:
|
Clone the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/yourusername/LectureSummarizer.git
|
git clone https://github.com/JRoshthen1/LectureSummarizer.git
|
||||||
```
|
```
|
||||||
Navigate to the project directory:
|
Navigate to the project directory:
|
||||||
|
|
||||||
|
|
@ -35,7 +33,7 @@ Install dependencies:
|
||||||
|
|
||||||
## Contributing
|
## 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.
|
- Create a branch in your fork for your contributions.
|
||||||
- Commit your changes with clear commit messages.
|
- Commit your changes with clear commit messages.
|
||||||
- Push your branch to your fork on GitHub and submit a pull request to the main project.
|
- Push your branch to your fork on GitHub and submit a pull request to the main project.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue