From 353be9f5c3140f5e27686de21ab038c8d689e2a6 Mon Sep 17 00:00:00 2001 From: Marcus Tillmanns Date: Wed, 9 Oct 2024 12:48:03 +0200 Subject: [PATCH] Copilot: Move description into markdown file Change-Id: Ib9f9fec4be31bc60739037883fad02d489303818 Reviewed-by: Alessandro Portale --- src/plugins/copilot/CMakeLists.txt | 1 + src/plugins/copilot/Copilot.json.in | 6 +----- src/plugins/copilot/Description.md | 8 ++++++++ 3 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 src/plugins/copilot/Description.md diff --git a/src/plugins/copilot/CMakeLists.txt b/src/plugins/copilot/CMakeLists.txt index 7c82008a065..6142b192e6d 100644 --- a/src/plugins/copilot/CMakeLists.txt +++ b/src/plugins/copilot/CMakeLists.txt @@ -1,5 +1,6 @@ add_qtc_plugin(Copilot PLUGIN_DEPENDS Core LanguageClient + LONG_DESCRIPTION_MD Description.md SOURCES authwidget.cpp authwidget.h copilot.qrc diff --git a/src/plugins/copilot/Copilot.json.in b/src/plugins/copilot/Copilot.json.in index 319888dbdec..9bdffdad8df 100644 --- a/src/plugins/copilot/Copilot.json.in +++ b/src/plugins/copilot/Copilot.json.in @@ -16,11 +16,7 @@ "Alternatively, this plugin may be used under the terms of the GNU General Public License version 3 as published by the Free Software Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT included in the packaging of this plugin. Please review the following information to ensure the GNU General Public License requirements will be met: https://www.gnu.org/licenses/gpl-3.0.html." ], "Description" : "View suggestions from GitHub Copilot in code editor.", - "LongDescription" : [ - "You also need:", - "- An active GitHub Copilot subscription", - "- GitHub Copilot Neovim plugin installed (requires Node.js)" - ], + "LongDescription" : ${LONG_DESCRIPTION}, "Url" : "https://www.qt.io", "DocumentationUrl" : "https://doc.qt.io/qtcreator/creator-copilot.html", ${IDE_PLUGIN_DEPENDENCIES} diff --git a/src/plugins/copilot/Description.md b/src/plugins/copilot/Description.md new file mode 100644 index 00000000000..a7dde131a41 --- /dev/null +++ b/src/plugins/copilot/Description.md @@ -0,0 +1,8 @@ +![Writing a function with Copilot](https://qtccache.qt.io/images/copilot/Copilot.gif) + +*Copilot in action* + +## You also need: + +- An active GitHub Copilot [subscription](https://github.com/features/copilot) +- GitHub Copilot Neovim plugin [installed](https://github.com/github/copilot.vim?tab=readme-ov-file#getting-started) (requires [Node.js](https://nodejs.org/en/download/package-manager))