mirror/QodeAssist
1
0
Fork 0
mirror of https://github.com/Palm1r/QodeAssist.git synced 2025-05-28 03:10:28 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc: Add llama.cpp description to README.md

Browse Source
This commit is contained in:
Petr Mironychev 2025-03-10 12:07:39 +01:00 committed by GitHub
parent 58c3e26e7f
commit 6b86637dcb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -27,17 +27,18 @@
2. [Install plugin to QtCreator](#install-plugin-to-qtcreator) 2. [Install plugin to QtCreator](#install-plugin-to-qtcreator)
3. [Configure for Anthropic Claude](#configure-for-anthropic-claude) 3. [Configure for Anthropic Claude](#configure-for-anthropic-claude)
4. [Configure for OpenAI](#configure-for-openai) 4. [Configure for OpenAI](#configure-for-openai)
4. [Configure for Mistral AI](#configure-for-mistral-ai) 5. [Configure for Mistral AI](#configure-for-mistral-ai)
4. [Configure for Google AI](#configure-for-google-ai) 6. [Configure for Google AI](#configure-for-google-ai)
5. [Configure for Ollama](#configure-for-ollama) 7. [Configure for Ollama](#configure-for-ollama)
6. [System Prompt Configuration](#system-prompt-configuration) 8. [Configure for llama.cpp](#configure-for-llamacpp)
7. [File Context Features](#file-context-features) 9. [System Prompt Configuration](#system-prompt-configuration)
9. [QtCreator Version Compatibility](#qtcreator-version-compatibility) 10. [File Context Features](#file-context-features)
10. [Development Progress](#development-progress) 11. [QtCreator Version Compatibility](#qtcreator-version-compatibility)
11. [Hotkeys](#hotkeys) 12. [Development Progress](#development-progress)
12. [Troubleshooting](#troubleshooting) 13. [Hotkeys](#hotkeys)
13. [Support the Development](#support-the-development-of-qodeassist) 14. [Troubleshooting](#troubleshooting)
14. [How to Build](#how-to-build) 15. [Support the Development](#support-the-development-of-qodeassist)
16. [How to Build](#how-to-build)
## Overview ## Overview
@ -51,6 +52,7 @@
- Automatic syncing with open editor files (optional) - Automatic syncing with open editor files (optional)
- Support for multiple LLM providers: - Support for multiple LLM providers:
- Ollama - Ollama
- llama.cpp
- OpenAI - OpenAI
- Anthropic Claude - Anthropic Claude
- LM Studio - LM Studio
@ -184,6 +186,18 @@ You're all set! QodeAssist is now ready to use in Qt Creator.
<img width="824" alt="Ollama Settings" src="https://github.com/user-attachments/assets/ed64e03a-a923-467a-aa44-4f790e315b53" /> <img width="824" alt="Ollama Settings" src="https://github.com/user-attachments/assets/ed64e03a-a923-467a-aa44-4f790e315b53" />
</details> </details>
## Configure for llama.cpp
1. Open Qt Creator settings and navigate to the QodeAssist section
2. Go to General tab and configure:
- Set "llama.cpp" as the provider for code completion or/and chat assistant
- Set the llama.cpp URL (e.g. http://localhost:8080)
- Fill in model name
- Choose template for model(e.g. llama.cpp FIM for any model with FIM support)
<details>
<summary>Example of llama.cpp settings: (click to expand)</summary>
<img width="829" alt="llama.cpp Settings" src="https://github.com/user-attachments/assets/8c75602c-60f3-49ed-a7a9-d3c972061ea2" />
</details>
## System Prompt Configuration ## System Prompt Configuration
The plugin comes with default system prompts optimized for chat and instruct models, as these currently provide better results for code assistance. If you prefer using FIM (Fill-in-Middle) models, you can easily customize the system prompt in the settings. The plugin comes with default system prompts optimized for chat and instruct models, as these currently provide better results for code assistance. If you prefer using FIM (Fill-in-Middle) models, you can easily customize the system prompt in the settings.