Fix installation + Add logo

.gitignore

@@ -3,4 +3,5 @@ __pycache__
 *.egg-info
 .DS_Store
 /build
-/dist
+/dist
+llama_assistant/_version.py

README.md

@@ -1,16 +1,23 @@
-# Llama Assistant - With Llama 3.2
+<p align="center">
+  <img alt="Llama Assistant" style="width: 128px; max-width: 100%; height: auto;" src="https://raw.githubusercontent.com/vietanhdev/llama-assistant/refs/heads/main/logo.png"/>
+  <h1 align="center">🌟 Llama Assistant 🌟</h1>
+  <p align="center">Your Local AI Assistant with Llama Models</p>
+</p>
+
+![](https://user-images.githubusercontent.com/18329471/234640541-a6a65fbc-d7a5-4ec3-9b65-55305b01a7aa.png)
 
 ![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)
 ![Llama 3](https://img.shields.io/badge/Llama-3-green.svg)
 ![License](https://img.shields.io/badge/license-MIT-orange.svg)
 ![Version](https://img.shields.io/badge/version-0.1.0-red.svg)
+![Stars](https://img.shields.io/github/stars/vietanhdev/llama-assistant.svg)
+![Forks](https://img.shields.io/github/forks/vietanhdev/llama-assistant.svg)
+![Issues](https://img.shields.io/github/issues/vietanhdev/llama-assistant.svg)
 
 A simple AI-powered assistant to help you with your daily tasks, powered by Llama 3.2. It can recognize your voice, process natural language, and perform various actions based on your commands: summarizing text, rephasing sentences, answering questions, writing emails, and more.
 
 This assistant can run offline on your local machine, and it respects your privacy by not sending any data to external servers.
 
-**Only support macOS for now. Windows and Linux support are coming soon.**
-
 ![Screenshot](https://raw.githubusercontent.com/vietanhdev/llama-assistant/refs/heads/main/screenshot.png)
 
 ## Features
@@ -25,7 +32,7 @@ This assistant can run offline on your local machine, and it respects your priva
 
 ## Technologies Used
 
-- ![Python](https://img.shields.io/badge/Python-3.10%2B-blue?style=flat-square&logo=python&logoColor=white)
+- ![Python](https://img.shields.io/badge/Python-3.8%2B-blue?style=flat-square&logo=python&logoColor=white)
 - ![Llama](https://img.shields.io/badge/Llama-3.2-yellow?style=flat-square&logo=meta&logoColor=white)
 - ![SpeechRecognition](https://img.shields.io/badge/SpeechRecognition-3.8-green?style=flat-square&logo=google&logoColor=white)
 - ![PyQt](https://img.shields.io/badge/PyQt-6-41CD52?style=flat-square&logo=qt&logoColor=white)
@@ -53,6 +60,32 @@ pip install llama-assistant
    pip install -r requirements.txt
    ```
 
+**Speed Hack for Apple Silicon (M1, M2, M3) users:** 🔥🔥🔥
+
+- Insall Xcode:
+
+```bash
+# check the path of your xcode install 
+xcode-select -p
+
+# xcode installed returns
+# /Applications/Xcode-beta.app/Contents/Developer
+
+# if xcode is missing then install it... it takes ages;
+xcode-select --install
+```
+
+- Build `llama-cpp-python` with METAL support:
+
+```bash
+pip uninstall llama-cpp-python -y
+CMAKE_ARGS="-DGGML_METAL=on" pip install -U llama-cpp-python --no-cache-dir
+pip install 'llama-cpp-python[server]'
+
+# you should now have llama-cpp-python v0.1.62 or higher installed
+llama-cpp-python         0.1.68
+```
+
 ## Usage
 
 Run the assistant using the following command:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "llama-assistant"
-version = "0.1.10"
+version = "0.1.11"
 authors = [
     {name = "Viet-Anh Nguyen", email = "vietanh.dev@gmail.com"},
 ]
@@ -31,6 +31,7 @@ dependencies = [
     "llama-cpp-python",
     "pynput",
     "SpeechRecognition",
+    "huggingface_hub",
 ]
 dynamic = []
 

requirements.txt

@@ -2,4 +2,5 @@ PyQt6==6.7.1
 SpeechRecognition==3.10.4
 markdown==3.7
 pynput==1.7.7
-llama-cpp-python
+llama-cpp-python
+huggingface_hub==0.25.1