diff --git a/README.md b/README.md index 43acf7e..d16c4c4 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This is my Final Project for CS50P. A implementation of a RAG System using Chrom ## Features 1. Custom GUI built with customtkinter and standard tkinter user interface. - optional `terminal` mode, with nice colors provided by the `termcolor` libary -2. RAG system to retrieve and process files from various sources (CSV, HTML, JSON, MD, PDF) using ChromaDB. +2. RAG system to retrieve and process files from various sources (CSV, HTML, MD, PDF and Webpages) using ChromaDB. 3. Seamless integration with Ollama API for generating responses based on the input text. 4. Supports both context-based and context-free conversations. 5. Code Highlighting: Either highlighted in red within the `terminal` or displayed in a separate widget using the `GUI`, this improves the readability and understanding of code snippets @@ -19,6 +19,7 @@ This is my Final Project for CS50P. A implementation of a RAG System using Chrom ```bash pip install -r requirements.txt ``` +3. If you have installed Python 3 via Homebrew on MacOS you are required to use `brew install python-tk` in order to run this project properly. ## Configuration @@ -69,7 +70,6 @@ python project.py You can provide the following files / links as context to Ollama: - .csv - .html -- .json - .md - .pdf - links to websites