Add build status link to README.md

This commit is contained in:
Petr Mironychev 2024-08-28 21:44:18 +02:00 committed by GitHub
parent e799d0bd00
commit 089bd0594e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,4 +1,5 @@
# QodeAssist # QodeAssist
[![Build plugin](https://github.com/Palm1r/QodeAssist/actions/workflows/build_cmake.yml/badge.svg?branch=main)](https://github.com/Palm1r/QodeAssist/actions/workflows/build_cmake.yml)
QodeAssist is an AI-powered coding assistant plugin for Qt Creator. It provides intelligent code completion and suggestions for C++ and QML, leveraging large language models through local providers like Ollama. Enhance your coding productivity with context-aware AI assistance directly in your Qt development environment. QodeAssist is an AI-powered coding assistant plugin for Qt Creator. It provides intelligent code completion and suggestions for C++ and QML, leveraging large language models through local providers like Ollama. Enhance your coding productivity with context-aware AI assistance directly in your Qt development environment.
@ -38,7 +39,8 @@ ollama run starcoder2:7b
``` ```
4. Download the QodeAssist plugin. 4. Download the QodeAssist plugin.
5. Launch Qt Creator and install the plugin: 5. Launch Qt Creator and install the plugin:
- Go to About -> About Plugins - Go to MacOS: Qt Creator -> About Plugins...
Windows\Linux: Help -> About Plugins...
- Click on "Install Plugin..." - Click on "Install Plugin..."
- Select the downloaded QodeAssist plugin archive file - Select the downloaded QodeAssist plugin archive file
@ -83,4 +85,4 @@ Create a build directory and run
where `<path_to_qtcreator>` is the relative or absolute path to a Qt Creator build directory, or to a where `<path_to_qtcreator>` is the relative or absolute path to a Qt Creator build directory, or to a
combined binary and development package (Windows / Linux), or to the `Qt Creator.app/Contents/Resources/` combined binary and development package (Windows / Linux), or to the `Qt Creator.app/Contents/Resources/`
directory of a combined binary and development package (macOS), and `<path_to_plugin_source>` is the directory of a combined binary and development package (macOS), and `<path_to_plugin_source>` is the
relative or absolute path to this plugin directory. relative or absolute path to this plugin directory.