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: Added quick refactoring feature description to README.md

Browse Source
This commit is contained in:
Petr Mironychev 2025-05-02 08:31:34 +02:00 committed by GitHub
parent dad8ab2bf3
commit 6ae95fec45
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -23,11 +23,12 @@
7. [Configure for Ollama](#configure-for-ollama) 7. [Configure for Ollama](#configure-for-ollama)
8. [Configure for llama.cpp](#configure-for-llamacpp) 8. [Configure for llama.cpp](#configure-for-llamacpp)
9. [System Prompt Configuration](#system-prompt-configuration) 9. [System Prompt Configuration](#system-prompt-configuration)
10. [File Context Features](#file-context-features) 10. [File Context Feature](#file-context-feature)
11. [QtCreator Version Compatibility](#qtcreator-version-compatibility) 11. [Quick Refactoring Feature](#quick-refactoring-feature)
12. [Development Progress](#development-progress) 12. [QtCreator Version Compatibility](#qtcreator-version-compatibility)
13. [Hotkeys](#hotkeys) 13. [Development Progress](#development-progress)
14. [Ignoring Files](#ignoring-files) 14. [Hotkeys](#hotkeys)
15. [Ignoring Files](#ignoring-files)
14. [Troubleshooting](#troubleshooting) 14. [Troubleshooting](#troubleshooting)
15. [Support the Development](#support-the-development-of-qodeassist) 15. [Support the Development](#support-the-development-of-qodeassist)
16. [How to Build](#how-to-build) 16. [How to Build](#how-to-build)
@ -202,7 +203,7 @@ You're all set! QodeAssist is now ready to use in Qt Creator.
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.
## File Context Features ## File Context Feature
QodeAssist provides two powerful ways to include source code files in your chat conversations: Attachments and Linked Files. Each serves a distinct purpose and helps provide better context for the AI assistant. QodeAssist provides two powerful ways to include source code files in your chat conversations: Attachments and Linked Files. Each serves a distinct purpose and helps provide better context for the AI assistant.
@ -235,6 +236,18 @@ Linked files provide persistent context throughout the conversation:
- Supports automatic syncing with open editor files (can be enabled in settings) - Supports automatic syncing with open editor files (can be enabled in settings)
- Files can be added/removed at any time during the conversation - Files can be added/removed at any time during the conversation
## Quick Refactoring Feature
### Setup
Since this is actually a small chat with redirected output, the main settings of the provider, model and template are taken from the chat settings
### Using
The request to model consist of instructions to model, selection code and cursor position
The default instruction is: "Refactor the code to improve its quality and maintainability." and sending if text field is empty
Also there buttons to quick call instractions:
* Repeat latest instruction, will activate after sending first request in QtCreator session
* Improve current selection code
* Suggestion alternative variant of selection code
* Other instructions[TBD]
## QtCreator Version Compatibility ## QtCreator Version Compatibility
- QtCreator 16.0.1 - 0.5.7 - 0.x.x - QtCreator 16.0.1 - 0.5.7 - 0.x.x