openkylin
/
extensions-repo
mirror of https://gitee.com/openkylin/extensions-repo.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

修改user-guide，修改简介、支持的平台、Qt开发、新功能等多个文件

This commit is contained in:
muruichao 2024-07-26 13:46:26 +08:00
parent f279b4c07d
commit 0856d19d8a
33 changed files with 132 additions and 854 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
user-guide/files/C-C++开发.md
View File

@ -1,78 +1,35 @@
# C-C++开发
通过通用集成开发环境进行C/C++项目开发。
- [环境准备](#1-环境准备)
- [C-C++项目创建与编辑](#2-cc项目创建与编辑)
- [编译与运行](#3编译与运行)
- [调试](#4调试)
# 1 环境准备
## 1.1 通过开发环境快速部署安装
- 点击帮助菜单中的“打开开发环境快速部署”子菜单，选择C/C++选项进行安装，将安装系统软件源中的编译调试工具和C/C++基础支持插件
## 1.1 编译器检查
开始之前准备C/C++编译环境,检查C/C++编译器。本系统都有自带的编译器(g++和gcc)，通过以下命令可以验证是是否正确安装了C/C++编译器
- 终端打开一个新的命令行，在命令行中输入以下命令，以验证C编译器是否安装正确
```
gcc --version
```
- 在命令行中输入以下命令，以验证C++编译器是否安装正确
```
g++ --version
```
如果C/C++编译器安装成功，那么在命令行中就会输出C/C++编译器的版本信息
## 1.2 安装clangd语言服务器
clangd为C/C++的语言服务器，Clangd插件需要安装9以上的clangd版本，通过以下方式可以安装clangd软件包
- 方式一：在命令行中参考输入以下命令，安装并验证clangd是否安装成功
```
sudo apt install clangd //在系统包以deb形式管理的操作系统上安装clangd
sudo yum install clang-tools-extra //或者在系统包以rpm形式管理的操作系统上安装clangd
clangd --version //检查是否正确安装
```
- 方式二：插件商店查找并安装插件管理插件extension dependency,插件安装后调用命令打开插件管理页面，查找clangd插件相关依赖进行安装，具体操作详情见：[插件依赖管理](插件依赖管理.md)
## 1.3 安装QT相关依赖
用户如果编译QT程序，可通过以下命令安装QT相关依赖包
- 在命令行中输入以下命令，安装QT4依赖包
```
sudo apt install libqt4-dev //在系统包以deb形式管理的操作系统上安装该软件
sudo yum install qt-devel //或在系统包以rpm形式管理的操作系统上安装该软件
```
- 在命令行中输入以下命令，安装QT5依赖包
```
sudo apt install qtbase5-dev //在系统包以deb形式管理的操作系统上安装该软件
sudo yum install qt5-qtbase-devel //或在系统包以rpm形式管理的操作系统上安装该软件
```
## 1.4 C/C++相关插件安装
## 1.2 手动安装
## 1.2.1 安装C/C++基础支持插件
- Clangd插件安装(该clangd插件ID是KylinIDETeam.vscode-clangd，插件的发布者是KylinIdeTeam。该插件为C/C++提供补全、导航和检查等语法功能)
- 启动通用集成开发环境
- 启动IDE基础平台
- 点击活动栏中的插件图标，调出插件视图
- 点击插件视图中的插件筛选器图标，选择Kylin-IDE(KylinCode)插件分类->C语言支持
- 点击Clangd进行安装
![图1 clangd插件安装](resources/c-c++/clangd-new-install.gif)
- Native Debug 安装(ID:KylinIdeTeam.debug,该插件提供C/C++调试功能)
- 启动通用集成开发环境
- Native Debug插件安装(ID:KylinIdeTeam.debug,该插件提供C/C++调试功能)
- 启动IDE基础平台
- 点击活动栏中的插件图标，调出插件视图。
- 点击插件视图中的插件筛选器图标，选择Kylin-IDE(KylinCode)插件分类->C语言支持
- 点击Native Debug安装
## 1.2.2 安装系统软件依赖
- 安装clangd（Clangd代码编辑插件依赖）
* 命令举例：`apt install clangd`或`yum install clang-tools-extra`
- 安装编译构建工具
* 命令举例：`apt install build-essential cmake ninja-build`或`yum install gcc gcc-c++ cmake ninja-build`
- 安装gdb（调试插件依赖）
* 命令举例：`apt install gdb`或`yum install gdb`
# 2 C/C++项目创建与编辑
## 2.1 项目创建
@ -92,7 +49,7 @@
### 2.1.2 通过项目创建插件创建c/c++程序
- 插件商店点击筛选器插件-》点击Kylin-IDE(KylinCode)插件分类-》点击项目创建-》点击安装项目管理插件Kylin Project Manager,插件安装后点击资源管理器视图，进入项目操作区创建C/C++程序，创建具体操作详情见：[项目管理插件](项目管理.md)
- 插件商店点击筛选器插件->点击Kylin-IDE(KylinCode)插件分类->点击项目创建->点击安装项目管理插件Kylin Project Manager,插件安装后点击资源管理器视图，进入项目操作区创建C/C++程序，创建具体操作详情见：[项目管理插件](项目管理.md)
![图5 项目创建插件创建程序](resources/c-c++/visix-new-project.gif)
## 2.2 编辑
@ -133,29 +90,6 @@
```
与C类似，编辑区支持C++程序语言高亮、补全、导航等功能，LoongArch平台仅支持变量或者函数名等定义处高亮）
### 2.2.3 Qt代码编辑支持和开发库头文件配置
- 首先创建QT项目qtdemo，新建main.cpp文件，编辑内容如下：
```cpp
#include <QCoreApplication>
#include <iostream>
using namespace std;
int main(int argc, char *argv[])
{
QCoreApplication a(argc, argv);
cout<<"Hello World!"<<endl;
return a.exec();
}
```
- 头文件配置
- 点击扩展-聚焦Clangd插件，点击设置，点击插件设置，
- 跳转到设置页面，在搜索设置中输入qt，点击工作区，在qt代码补全头文件设置中选择设置QT4/QT5头文件路径，点击重启clangd服务，如下图所示为QT代码补全头文件设置
![图9 QT头文件设置](resources/c-c++/qt-new.gif)
# 3.编译与运行
@ -358,27 +292,6 @@ launch.json文件创建成功后默认配置如下：
}
```
QT 程序修改launch.json文件内容如下：
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Qt-Debug",
"type": "gdb",
"request": "launch",
"target": "${workspaceFolder}/build/${workspaceFolderBasename}",
"arguments": "",
"cwd": "${fileDirname}",
"gdbpath": "gdb",
"valuesFormatting": "parseText",
"preLaunchTask": "build"
}
]
}
```
- 调试常用参数介绍：
- program：代表要运行的二进制文件所在路径

17
user-guide/files/Go开发.md
View File

@ -1,10 +1,10 @@
# Go开发
# 1 环境准备
## 1.1 通过开发环境快速部署安装
- 点击帮助菜单中的“打开开发环境快速部署”子菜单，选择Go选项进行安装，将安装系统软件源中的Golang和Go基础支持插件
## 1、概述
通过通用集成开发环境进行Go项目开发。
## 2、环境准备
- 请先在系统中自行安装Go运行环境。
## 1.2 手动安装
- 安装Go运行环境。
- Go插件安装 (该Go插件ID为KylinIdeTeam.go，插件的发布者是KylinIdeTeam。)
- 启动通用集成开发环境
- 点击活动栏中的插件图标，调出插件视图。
@ -49,8 +49,6 @@
创建的tasks.json默认内容如下：
```json
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
@ -64,8 +62,6 @@
- 修改tasks.json文件，修改后内容如下：
```json
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
@ -99,9 +95,6 @@
创建的launch.json默认内容如下：
```json
{
// 使用 IntelliSense 了解相关属性。
// 悬停以查看现有属性的描述。
// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{

2
user-guide/files/IDE基础平台.md
View File

@ -1,5 +1,5 @@
# IDE基础平台
改造自微软Visual Studio Code(VSCode)开源项目 [Code OSS](https://github.com/microsoft/vscode)，仅提供基本图形界面和插件架构，开发功能需要插件配合。桌面版的IDE基础平台是一个electron应用，远程开发版的IDE基础平台是一个Web服务，桌面版和远程开发版界面类似。
- [用户界面](#用户界面)
- [设置](#设置)
- [编辑功能](#编辑功能)

24
user-guide/files/JavaScript开发.md
View File

@ -1,21 +1,8 @@
# JavaScript开发
## 概述
通过通用集成开发环境进行JavaScript项目开发。
## 环境准备
- nodejs软件包：提供nodejs运行时，运行javaScript项目。
- JavaScript开发相关插件KylinIDETeam.js-debug和KylinIDETeam.historydebug
- KylinIDETeam.js-debug：调试NodeJS应用,该插件为Kylin-Code(Kylin-IDE)内置插件，无需用户手动安装
- KylinIDETeam.historydebug：历史调试插件，在调试过程中记录中断时的堆栈信息，并可在调试过程中或结束后查看调试时的堆栈信息，用户可在调试过程中记录关心的调试信息以便在需要的时候复现调试信息.用户可以根据需要决定是否安装
- KylinIDETeam.historydebug的安装
- 启动通用集成开发环境
- 点击活动栏中的插件图标，调出插件视图。
- 点击插件视图中的插件筛选器图标，选择Kylin-IDE(KylinCode)插件分类->Javascript语言支持
![图1](./resources/JavaScript/ext-inst.jpg)
- 通过以上步骤找到javaScript语言相关插件KylinIDETeam.js-debug（KylinIDETeam.js-debug为内置插件无需再次安装）和KylinIDETeam.historydebug，点击KylinIDETeam.historydebug插件右下角的安装图标进行安装操作
- 安装成功后，重新加载窗口
- 插件：js相关编辑、调试插件为内置插件，无需手动安装
- nodejs：如进行nodejs开发，请自行安装nodejs环境
# 快速开始
@ -46,8 +33,6 @@
创建的tasks.json默认内容如下：
```json
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
@ -61,8 +46,6 @@
- 修改tasks.json文件，修改后内容如下：
```json
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
@ -94,9 +77,6 @@
创建的launch.json默认内容如下：
```json
{
// 使用 IntelliSense 了解相关属性。
// 悬停以查看现有属性的描述。
// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{

2
user-guide/files/Java开发.md
View File

@ -2,7 +2,7 @@
## 1、概述
本文档介绍用户如何通过IDE软件进行Java项目开发。
本文档介绍用户如何进行Java项目开发。
包括java编辑、编译、运行、调试等过程。

16
user-guide/files/Python开发.md
View File

@ -1,10 +1,11 @@
# Python开发
## 1、概述
通过通用集成开发环境进行Python项目开发。
## 环境准备
### 通过开发环境快速部署安装
- 点击帮助菜单中的“打开开发环境快速部署”子菜单，选择Python选项进行安装，将安装系统软件源中的Python版本和Python基础支持插件
## 2、环境准备
- 请先在系统中自行安装Python运行环境。
### 手动安装
- 安装Python运行环境。
- Python插件安装(该Python插件ID为KylinIdeTeam.python，插件的发布者是KylinIdeTeam。)
- 启动通用集成开发环境
- 点击活动栏中的插件图标，调出插件视图。
@ -43,8 +44,6 @@
创建的tasks.json默认内容如下：
```json
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
@ -58,8 +57,6 @@
- 修改tasks.json文件，修改后内容如下：
```json
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
@ -91,9 +88,6 @@
创建的launch.json默认内容如下：
```json
{
// 使用 IntelliSense 了解相关属性。
// 悬停以查看现有属性的描述。
// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/? linkid=830387
"version": "0.2.0",
"configurations": [
{

9
user-guide/files/Qt开发.md
View File

@ -18,8 +18,8 @@
- [QMake项目编辑代码](#qmake项目编辑代码)
- [QMake项目构建（生成）](#qmake项目构建生成)
- [QMake项目调试和运行](#qmake项目调试和运行)
- [UI设计](#UI设计)
- [查看Qt帮助文档](#查看Qt帮助文档)
- [UI设计](#ui设计)
- [查看Qt帮助文档](#查看qt帮助文档)
## 概述
- Qt开发功能由一组插件配合完成。对CMake类型的项目支持较好，对QMake类型的项目提供部分支持。目前迭代开发中
@ -46,7 +46,7 @@
- KylinIdeTeam.qt-support
- ms-vscode.cmake-tools
- ms-vscode.cpptools
- 使用Kylin-IDE时，请注意，若之前已安装Clangd插件（插件ID：kylinideteam.vscode-clangd），请将该插件版本升至大于等于0.2.11
- 使用Kylin-IDE时，请注意，若之前已安装Clangd插件（插件ID：kylinideteam.vscode-clangd），请将该插件版本升至大于等于0.2.12
- 安装方式2：在[openKylin extensions-repo仓库](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam)中，根据插件名称找到下载链接，下载安装
### 依赖软件安装
@ -62,6 +62,7 @@
* 命令举例：`apt install gdb`或`yum install gdb`
- 安装Qt
* 命令举例：`apt install qt5-default qt5-qmake qttools5-dev-tools`或`yum install qt5-qtbase-devel qt5-qttools-devel`
- 若使用Qt文档查看功能，需安装对应版本Qt文档，例如：`apt install qt5-doc qt5-doc-html`或`yum install qt5-doc qt5-doc-html`
- 使用VSCode、Linux系统时不需安装clangd，其他软件请参考上文“方法二”；使用Windows系统时，请参考Qt Support插件readme
## CMake项目
@ -191,5 +192,5 @@
* 在编辑器中右键，选择“在Qt设计器中打开”，调用Qt Designer打开ui文件
## 查看Qt帮助文档
当鼠标光标位于某一个Qt 库中的符号处时，按下 `Shift + F1` 快捷键，将会在编辑器旁边显示该符号的帮助文档，如下如所示:
当鼠标光标位于某一个Qt 库中的符号处时，按下 `Shift + F1` 快捷键，将会在编辑器旁边显示该符号的帮助文档，如下如所示。使用此功能前需安装对应版本Qt文档，例如：`apt install qt5-doc qt5-doc-html`或`yum install qt5-doc qt5-doc-html`。注意，此功能目前不支持远程开发方式，仅桌面版Kylin-IDE能够正常使用。
![查看Qt帮助文档](resources/qt/f1-doc.png "查看Qt帮助文档")

BIN
user-guide/files/resources/brief/desktop.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 136 KiB

BIN
user-guide/files/resources/brief/fast-deploy-env.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 53 KiB

BIN
user-guide/files/resources/brief/remote-ext.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 149 KiB

BIN
user-guide/files/resources/brief/web-ide.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 162 KiB

BIN
user-guide/files/resources/newfunction/fast-deploy-env.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 53 KiB

BIN
user-guide/files/resources/newfunction/instGuide_1.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 43 KiB

BIN
user-guide/files/resources/newfunction/instGuide_2.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 53 KiB

BIN
user-guide/files/resources/newfunction/instGuide_3.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 36 KiB

BIN
user-guide/files/resources/newfunction/instGuide_4.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 43 KiB

BIN
user-guide/files/resources/newfunction/instGuide_5.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 69 KiB

BIN
user-guide/files/resources/newfunction/instGuide_6.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 31 KiB

BIN
user-guide/files/resources/newfunction/instGuide_7.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 56 KiB

BIN
user-guide/files/resources/newfunction/kylin-ide-icon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 31 KiB

BIN
user-guide/files/resources/newfunction/qt-doc.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 420 KiB

BIN
user-guide/files/resources/newfunction/qt-edit-make.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 368 KiB

BIN
user-guide/files/resources/newfunction/qt-pro.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 126 KiB

161
user-guide/files/打包.md
View File

@ -1,161 +0,0 @@
# 打包功能使用说明
## 1、对应插件安装
### 1.1.1 通过插件筛选器，找到 Kylin Project Manager 插件
![图1-1](resources/project-manager/pm-link.png "插件筛选项目管理")
点击安装进行插件安装
- 搜索到相应的插件;
![图1-2](resources/project-manager/pm-install-1.png "项目管理安装")
![图1-3](resources/project-manager/pm-install-2.png "项目管理安装")
- 完成安装。
- 如果是版本升级则需要重新加载主程序插件才生效，请根据提示操作完成安装。
![图1-4](resources/project-manager/pm-installed-1.png "项目管理已安装")
![图1-5](resources/project-manager/pm-installed-2.png "项目管理已安装")
## 2、 Rpm/Deb打包功能使用方法
### 2.1、 依赖安装
1.依赖安装
- 桌面操作系统依赖安装执行下面的命令
sudo apt install rpm (桌面操作系统一般是Debian系统，默认安装dpkg包管理。需注意若此时源里不支持安装rpm时，rpm打包功能无法正常使用，需要用户自行通过离线安装包进行安装rpm及其所需依赖包)
- 服务器操作系统依赖安装执行下面的命令
sudo yum install dpkg (服务器操作系统一般是Red Hat系统，默认安装rpm包管理。需注意若此时源里不支持安装dpkg时，dpkg打包功能无法正常使用，需要用户自行通过离线安装包进行安装dpkg及其所需依赖包)
### 2.2、 打包文件准备
1.通过IDE打开准备打包的工程文件；
2.编译。
### 2.3、 Deb打包
1.点击侧边栏的项目操作区，显示如下：
![图1-1](./resources/package/1.png)
2.点击打包RPM/DEB包按钮，显示如下：
![图1-2](./resources/package/2.png)
3.点击打包文件选择按钮，显示如下：
![图1-3](./resources/package/3.png)
4.填写打包文件的安装路径，eg：/usr/bin
5.选择需要打包的文件，显示如下：
![图1-4](./resources/package/4.png)
6.如果需要增加一组源文件和目标路径的填写，点击+号即可，所有需要打包的文件填写完毕后直接点击确定按钮；
7.填写必须的打包字段信息，显示如下：
![图1-5](./resources/package/5.png)
8.根据需要，点击显示展示更多按钮，显示其他非必填字段信息，显示如下：
![图1-6](./resources/package/6.png)
9.点击下一步，根据需要填写其他非必填字段信息，显示如下：
![图1-7](./resources/package/7.png)
10.点击下一步，根据需要填写安装和卸载脚本信息，显示如下：
![图1-8](./resources/package/8.png)
11.点击打包按钮，打包成功，显示如下：
![图1-9](./resources/package/9.png)
12.如果需要安装成功打包的DEB包，点击安装按钮，输入密码，显示如下：
![图1-10](./resources/package/10.png)
　　
### 2.4、 Rpm打包
1.点击打包RPM/DEB包按钮，显示如下：
![图1-11](./resources/package/2.png)
2.点击打包类型选择按钮，选择rpm，并填写必填字段信息，显示如下：
![图1-12](./resources/package/12.png)
3.根据需要，点击显示展示更多按钮，显示其他非必填字段信息，显示如下：
![图1-13](./resources/package/13.png)
4.点击下一步，根据需要填写其他非必填字段信息，显示如下：
![图1-14](./resources/package/14.png)
5.点击下一步，根据需要选择安装文件和其他非必填字段信息，显示如下：
![图1-15](./resources/package/15.png)
6.如果需要增加一组源文件和目标路径的填写，点击+号即可，所有需要打包的文件填写完毕后直接点击确定按钮，显示如下：
![图1-16](./resources/package/16.png)
7.点击打包按钮，打包成功，显示如下：
![图1-17](./resources/package/17.png)
8.如果需要安装成功打包的RPM包，点击安装按钮，输入密码。
## 3、 JAR/WAR打包
### 3.1、 JAR打包
1.点击侧边栏的项目操作区，显示如下：
![图2-1](./resources/package/1.png)
2.点击打包JAR/WAR包按钮，显示如下：
![图2-2](./resources/package/18.png)
3.点击选择目录按钮，选择导出JAR包的路径;
4.点击打包按钮，显示如下：
![图2-3](./resources/package/19.png)
5.成功导出JAR包，显示如下：
![图2-4](./resources/package/20.png)
### 3.2、 WAR打包
1.点击侧边栏的项目操作区，显示如下：
![图2-5](./resources/package/1.png)
2.点击打包JAR/WAR包按钮，显示如下：
![图2-6](./resources/package/18.png)
3.点击打包类型下拉框，选择WAR包;
4.点击打包按钮，显示如下：
![图2-7](./resources/package/21.png)
5.成功构建WAR包，显示如下：
![图2-8](./resources/package/22.png)

181
user-guide/files/插件列表.md
View File

@ -1,181 +0,0 @@
<table width="1340" border="0" cellpadding="0" cellspacing="0" style="width:1005.00pt;border-collapse:collapse;table-layout:fixed;">
<colgroup><col width="57" class="xl65" style="mso-width-source:userset;mso-width-alt:1824;">
<col width="232" style="mso-width-source:userset;mso-width-alt:7424;">
<col width="146" style="mso-width-source:userset;mso-width-alt:4672;">
<col width="479" style="mso-width-source:userset;mso-width-alt:15328;">
<col width="335" style="mso-width-source:userset;mso-width-alt:10720;">
<col width="91" style="mso-width-source:userset;mso-width-alt:2912;">
</colgroup><tbody><tr height="33.33" style="height:25.00pt;mso-height-source:userset;mso-height-alt:500;">
<td class="xl68" height="33.33" width="1340" colspan="6" style="height:25.00pt;width:1005.00pt;border-right:.5pt solid windowtext;border-bottom:.5pt solid windowtext;" x:str="">KylinIdeTeam开发适配的插件列表</td>
</tr>
<tr height="18" class="xl65" style="height:13.50pt;">
<td class="xl70" height="18" style="height:13.50pt;" x:str="">序号</td>
<td class="xl70" x:str="">功能</td>
<td class="xl70" x:str="">是否必装</td>
<td class="xl70" x:str="">插件展示名称</td>
<td class="xl70" x:str="">插件ID</td>
<td class="xl70" x:str="">链接</td>
</tr>
<tr height="36" class="xl66" style="height:27.00pt;">
<td class="xl71" height="36" style="height:27.00pt;" x:num="">1</td>
<td class="xl72" x:str="">远程开发</td>
<td class="xl72" x:str="">可选，服务器系统仅支持远程开发模式</td>
<td class="xl72" x:str="">Kylin remote development</td>
<td class="xl72" x:str="">xhafei.remote-dev</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam/remote-dev" target="_parent">链接</a></td>
</tr>
<tr height="22.67" class="xl67" style="height:17.00pt;mso-height-source:userset;mso-height-alt:340;">
<td class="xl71" height="22.67" style="height:17.00pt;" x:num="">2</td>
<td class="xl74" x:str="">插件依赖管理器</td>
<td class="xl75" x:str="">必装</td>
<td class="xl76" x:str="">extension dependency</td>
<td class="xl77" x:str="">KylinIdeTeam.extension-dependency</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-extension-dependency" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">3</td>
<td class="xl75" x:str="">离线插件管理器</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">offline extensions manager</td>
<td class="xl77" x:str="">KylinIdeTeam.offline-extensions-manager</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-offline-extensions-manager" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">4</td>
<td class="xl77" x:str="">git增强</td>
<td class="xl77" x:str="">可选</td>
<td class="xl76" x:str="">Gitlens lower version for friendly licence</td>
<td class="xl77" x:str="">KylinIdeTeam.gitlens</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-gitlens" target="_parent">链接</a></td>
</tr>
<tr height="45.33" class="xl67" style="height:34.00pt;mso-height-source:userset;mso-height-alt:680;">
<td class="xl71" height="45.33" style="height:34.00pt;" x:num="">5</td>
<td class="xl75" x:str="">项目创建；目前支持C/C++、部分Java项目创建</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">Kylin Project Manager</td>
<td class="xl76" x:str="">KylinIdeTeam.project-manager</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/vscode-create-project" target="_parent">链接</a></td>
</tr>
<tr height="18" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">6</td>
<td class="xl78" x:str="">C/C++编辑</td>
<td class="xl78" x:str="">C/C++开发必装</td>
<td class="xl78" x:str="">Clangd（semantic highlighting for clangd8 and for KylinOS）</td>
<td class="xl78" x:str="">KylinIdeTeam.vscode-clangd</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam/vscode-clangd" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">7</td>
<td class="xl75" x:str="">C/C++调试</td>
<td class="xl75" x:str="">C/C++开发必装</td>
<td class="xl76" x:str="">Native Debug(fix some bugs)</td>
<td class="xl77" x:str="">KylinIdeTeam.debug</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/native-debug" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">8</td>
<td class="xl75" x:str="">cmake文件编辑支持</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">CMake IntelliSence</td>
<td class="xl77" x:str="">KylinIdeTeam.cmake-intellisence</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/cmake-intellisence" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">9</td>
<td class="xl75" x:str="">Python编辑和调试</td>
<td class="xl75" x:str="">Python开发必装</td>
<td class="xl76" x:str="">Python（with jedi language server）</td>
<td class="xl77" x:str="">KylinIdeTeam.python</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-python" target="_parent">链接</a></td>
</tr>
<tr height="42.67" class="xl67" style="height:32.00pt;mso-height-source:userset;mso-height-alt:640;">
<td class="xl71" height="42.67" style="height:32.00pt;" x:num="">10</td>
<td class="xl75" x:str="">Java插件集合包，可以把下面列出的Java支持插件都安装上</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">Java Pack (Support openjdk11 runtime)</td>
<td class="xl77" x:str="">KylinIdeTeam.vscode-java-pack</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-vscode-java-pack" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">11</td>
<td class="xl75" x:str="">Java编辑</td>
<td class="xl75" x:str="">Java开发必装</td>
<td class="xl76" x:str="">Java (Support openjdk11 runtime)</td>
<td class="xl77" x:str="">KylinIdeTeam.java</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-java" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">12</td>
<td class="xl75" x:str="">Java调试</td>
<td class="xl75" x:str="">Java开发必装</td>
<td class="xl76" x:str="">Java Debug (Support openjdk11 runtime)</td>
<td class="xl76" x:str="">KylinIdeTeam.vscode-java-debug</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/vscode-java-debug" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">13</td>
<td class="xl75" x:str="">Java项目管理使用</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">Java Dependency (Support openjdk11 runtime)</td>
<td class="xl77" x:str="">KylinIdeTeam.vscode-java-dependency</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-vscode-java-dependency" target="_parent">链接</a></td>
</tr>
<tr height="36" class="xl67" style="height:27.00pt;">
<td class="xl71" height="36" style="height:27.00pt;" x:num="">14</td>
<td class="xl75" x:str="">Java项目管理使用，Run &amp; Debug JUnit/TestNG Test Cases</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">Java Test (Support openjdk11 runtime)</td>
<td class="xl77" x:str="">KylinIdeTeam.vscode-java-test</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-vscode-java-test" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">15</td>
<td class="xl75" x:str="">Java项目管理使用，maven支持</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">Java Maven (Support openjdk11 runtime)</td>
<td class="xl77" x:str="">KylinIdeTeam.vscode-maven</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-vscode-maven" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">16</td>
<td class="xl75" x:str="">Java项目管理使用，gradle支持</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">Java Gradle (Support openjdk11 runtime)</td>
<td class="xl77" x:str="">KylinIdeTeam.vscode-gradle</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-vscode-gradle" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">17</td>
<td class="xl79" x:str="">Go编辑和调试</td>
<td class="xl79" x:str="">Go开发必装</td>
<td class="xl80" x:str="">Go（for KylinOS）</td>
<td class="xl81" x:str="">KylinIdeTeam.go</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/ide-go" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">18</td>
<td class="xl75" x:str="">历史调试</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">historyDebug</td>
<td class="xl77" x:str="">KylinIdeTeam.historydebug</td>
<td class="xl73" x:str=""><a href="https://gitee.com/xhafei/historydebug" target="_parent">链接</a></td>
</tr>
<tr height="18" class="xl67" style="height:13.50pt;">
<td class="xl71" height="18" style="height:13.50pt;" x:num="">19</td>
<td class="xl75" x:str="">死锁检测</td>
<td class="xl75" x:str="">可选</td>
<td class="xl76" x:str="">deadlock-detect</td>
<td class="xl77" x:str="">KylinIdeTeam.deadlock-detect</td>
<td class="xl73" x:str=""><a href="https://gitee.com/openkylin/deadlock-detect" target="_parent">链接</a></td>
</tr>
<!--[if supportMisalignedColumns]-->
<tr width="0" style="display:none;">
<td width="57" style="width:43;"></td>
<td width="232" style="width:174;"></td>
<td width="146" style="width:110;"></td>
<td width="479" style="width:359;"></td>
<td width="335" style="width:251;"></td>
<td width="91" style="width:68;"></td>
</tr>
<!--[endif]-->
</tbody></table>

BIN
user-guide/files/插件列表.xlsx
View File

Binary file not shown.

27
user-guide/files/支持的平台.md
View File

@ -1,24 +1,13 @@
# 支持的平台
- Kylin-IDE
* IDE基础平台1.1.0版本前
- 支持X86、ARM（飞腾）、LoongArch架构
- 支持银河麒麟桌面操作系统V10（桌面应用模式、远程开发模式）
- 支持银河麒麟服务器操作系统V10（仅远程开发模式）
* IDE基础平台1.1.0版本后
- 将区分桌面版、远程开发插件版、WebIDE版（正在内部迭代开发中）
- 桌面版
* X86、ARM（飞腾）架构
* 银河麒麟桌面操作系统V10
- 远程开发插件版
* 需安装在桌面版IDE基础平台中
* 支持X86、ARM（飞腾）、LoongArch架构，MIPS和SW架构按具体需求支持
* 支持银河麒麟桌面和服务器操作系统V10
* 未来计划支持Windows操作系统
- WebIDE版（正在内部迭代开发中）
* 不依赖IDE基础平台，使用小巧的客户端
* 支持X86、ARM（飞腾）、LoongArch架构，MIPS和SW架构按具体需求支持
* 支持银河麒麟桌面和服务器操作系统V10
* 支持Windows操作系统
* 桌面版
- 支持X86、ARM（飞腾）、银河麒麟桌面操作系统
* 远程开发插件版
- 客户端（插件，开发机）：安装在桌面版Kylin-IDE中时，支持的平台见上文；安装在VSCode中时，支持X86、Windows10、Windows11系统
- 服务端（远程机）：支持X86、ARM（飞腾）、LoongArch、银河麒麟桌面和服务器操作系统，可根据需要支持更多的平台
* 远程开发WebIDE版
- 客户端（开发机）：目前已支持X86、银河麒麟桌面操作系统。计划支持X86、ARM（飞腾）、LoongArch、银河麒麟桌面和服务器操作系统；X86、Windows10和Windows11操作系统。可根据需要支持更多的平台；注意，操作系统需安装浏览器
- 服务端（远程机）：与插件版共用一套服务端，支持的平台见上文
* 建议内存：>= 8G
* 建议剩余存储空间：>= 5G
- Kylin-Code

39
user-guide/files/新功能.md
View File

@ -1,23 +1,26 @@
# 新功能介绍
- [新图标](#新图标)
- [使用方式](#使用方式)
- [开发环境快速部署](#开发环境快速部署)
- [Qt开发插件集](#qt开发插件集)
该文档用于介绍集成开发环境新增功能。
## 新图标
- 之前红蓝犄角的图标设计较简陋，重新设计了图标，新图标见下图
- ![qt文档查看](./resources/newfunction/kylin-ide-icon.png)
## 1. 安装引导功能
## 使用方式
- 按使用方式区分了桌面版、远程开发插件版、远程开发WebIDE版，见[简介章节](./简介.md)
### 1.1 功能介绍
## 开发环境快速部署
- 以选项形式快速安装基础编程环境
- 入口
* 安装后首次使用
* 帮助菜单->打开开发环境快速部署子菜单
- ![开发场景选择](./resources/newfunction/fast-deploy-env.png)
安装引导功能用于引导用户根据开发场景安装基础功能插件、安装依赖软件、配置基本开发环境。支持在线安装，需要连接互联网下载插件和依赖软件。目前Kylin-Code v0.3.0已集成该功能，但仅支持Openkylin X86操作系统
### 1.2 安装使用
- 安装Kylin-Code v0.3.0或0.3.0以上版本
- Kylin-Code首次启动显示安装引导界面，非首次启动点击菜单栏中的帮助->打开安装器选项显示安装引导界面
- ![安装引导界面](./resources/newfunction/instGuide_1.jpg)
- 根据提示选择开发场景
- ![开发场景](./resources/newfunction/instGuide_2.jpg)
- 点击确定，进行授权验证
- ![授权验证](./resources/newfunction/instGuide_5.jpg)
- 安装
- ![安装](./resources/newfunction/instGuide_7.jpg)
- 安装完成
- ![下载安装](./resources/newfunction/instGuide_6.jpg)
## Qt开发插件集
- 支持cmake类型和qmake类型qt项目编辑、构建、调试的自动配置，图形开发需调用qt-designer。安装qt文档后，支持qt文档查看（远程开发版暂不支持qt文档查看功能）
- 帮助文档：[链接](./Qt开发.md)
- ![qt cmake项目创建](./resources/newfunction/qt-pro.png)
- ![qt qmake编辑构建](./resources/newfunction/qt-edit-make.png)
- ![qt文档查看](./resources/newfunction/qt-doc.png)

20
user-guide/files/死锁检测.md
View File

@ -44,23 +44,7 @@
![图3-1](./resources/deadlock-detect/dld-local-operation.png "本地检测")
## 4、远程检测
- 点击“远程检测”
- 已知一个远程主机的IP地址及远程主机的用户名及密码，在远程主机上打开一个终端执行一个C/C++死锁测试程序，并通过top获pidof等命令获取到该死锁测试程序的进程PID。
- 页面内包括：
- 被检测进程PID输入框
- 远程主机IP地址输入框
- 远程用户账号输入框
- 远程用户密码输入框
- “开始检测”按钮
- 检测结果输出区
- 分别输入上述各个输入框的内容，点击开始检测，成功检测到死锁，并在检测结果输入区内显示“线程死锁关系”和“死锁关系图”
![图4-1](./resources/deadlock-detect/dld-remote-operation.png "远程检测")
## 5、Java进程死锁检测
## 4、Java进程死锁检测
- 点击"Java进程死锁检测"
- 打开一个终端执行一个Java死锁测试程序，并通过top获pidof等命令获取到该死锁测试程序的进程PID。
- 页面内包括：
@ -72,4 +56,4 @@
- 检测结果输出区
- 分别输入进程PID和当前系统用户密码，点击开始检测，成功检测到死锁，并在检测结果输入区内显示“线程死锁关系”和“死锁关系图”
![图5-1](./resources/deadlock-detect/dld-java-operation.png "Java进程死锁检测")
![图4-1](./resources/deadlock-detect/dld-java-operation.png "Java进程死锁检测")

247
user-guide/files/版本管理工具.md
View File

@ -1,247 +0,0 @@
# 1、 版本管理工具安装使用说明
## 1.1、 插件安装
IDE基础平台已经集成了基本的git功能。使用git增强功能，例如代码文件内显示git操作历史，需要安装如下步骤安装插件：
1. 通过插件筛选器，点击源代码管理，找到 Gitlens lower version for friendly licence 插件;
![图1-1](./resources/git/18.png)
2. 点击安装进行插件安装
- 搜索到相应的插件;
![图1-2](./resources/git/19.png)
- 点击插件后，显示如下界面;
![图1-3](./resources/git/20.png)
3. 安装完成
- 安装完成后，若提示需要重新加载主程序插件才生效，请根据提示操作完成安装;
![图1-4](./resources/git/22.png)
- 安装成功页面如下:
![图1-5](./resources/git/21.png)
- 用户需要查看插件相应的操作界面，需要点击源代码管理，显示如下;
![图1-6](./resources/git/23.png)
## 2.1、 Git配置
1. 依赖安装
- 桌面操作系统依赖安装执行下面的命令
sudo apt install git
- 服务器操作系统依赖安装执行下面的命令
sudo yum install git
2. 先配置Git账户，在终端中输入以下命令进行配置，其中用户姓名和邮箱需要根据用户实际账号和邮箱进行修改和配置;
- git config --global user.name "kylin"
git config --global user.email "kylin@kylinos.cn"
- 配置成功后，家目录下的.gitconfig文件显示如下:
![图2-1](./resources/git/24.png)
## 3.1、 功能说明
1. 根据用户需求点击相应菜单进行操作
![图3-1](./resources/git/2.png)
### 3.1.1、 克隆菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击克隆菜单,键入代码仓库的URL;
![图3-2](./resources/git/3.png)
3. 用户进行代码开发;
4. 点击提交菜单，将更改文件保存并提交;
5. 点击推送按钮;
6. 输入账号和密码。
　　
### 3.1.2、 提交菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击源代码管理更多菜单，显示如下：
![图3-3](./resources/git/4.png)
3. 鼠标移动到提交，显示如下：
![图3-4](./resources/git/5.png)
4. 根据用户的需求，点击相应的提交菜单；
5. 提交菜单功能用于提交修改文件；
6. 提交已暂存的文件菜单功能表示仅提交暂存的文件；
7. 全部提交菜单功能用于提交所有修改文件；
8. 撤销上次提交菜单功能表示撤销上次提交；
9. 中止变基菜单功能为中止变基；
10. 提交已暂存文件（修改）菜单功能表示将暂存的文件添加到上一次的提交中；
11. 全部提交菜单（修改）菜单功能表示将全部修改的文件添加到上一次的提交中；
12. 提交已暂存文件（已署名）菜单功能表示将暂存的文件以及作者签名添加到提交中；
13. 全部提交菜单（已署名）菜单功能表示将全部修改的文件以及作者签名添加到提交中；
14. 添加贡献者菜单功能用于添加贡献者。
　　
### 3.1.3、 更改菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击源代码管理更多菜单，显示如下:
![图3-5](./resources/git/6.png)
3. 鼠标移动到更改，显示如下：
![图3-6](./resources/git/7.png)
4. 根据用户的需求，点击相应的菜单;
5. 暂存所有的更改菜单功能用于缓存所有修改文件;
6. 取消暂存的文件菜单功能表示取消暂存的文件;
7. 放弃所有更改菜单功能表示放弃所有的修改文件，并删除。
### 3.1.4、 拉取，推送菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击源代码管理更多菜单，显示如下:
![图3-7](./resources/git/8.png)
3. 鼠标移动到拉取，推送，显示如下:
![图3-8](./resources/git/9.png)
　　
4. 根据用户的需求，点击相应的菜单;
5. 同步菜单功能用于将远程仓库代码同步到本地;
6. 拉取菜单功能用于将远程仓库的代码拉取到本地;
7. 拉取（变基）菜单功能表示将远程仓库的代码变基拉取到本地;
8. 拉取自...菜单功能表示将选择的远程仓库的代码拉取到本地;
9. 推送菜单功能表示将提交的文件推送到远程仓库;
10. 推送到...菜单功能表示将提交的文件推送到指定远程仓库;
11. 抓取菜单功能用于获取远程仓库的代码更改;
12. 获取（删除）菜单功能用于获取修剪后远程仓库的代码更改;
13. 从所有远程存储库中拉取菜单功能表示从远程仓库的所有分支中获取代码更改。
　　
### 3.1.5、 分支菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击源代码管理更多菜单，显示如下：
![图3-9](./resources/git/10.png)
　　 　
3. 鼠标移动到分支，显示如下：
![图3-10](./resources/git/11.png)
4. 根据用户的需求，点击相应的菜单;
5. 合并分支菜单功能用于合并分支;
6. 变基分支菜单功能用于将分支代码进行变基合并;
7. 创建分支菜单功能用于创建新的分支;
8. 从现有来源创建新的分支...菜单功能用于在现有的来源基础上创建新的分支;
9. 重命名分支菜单功能用于将分支进行重命名。
### 3.1.6、 远程菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击源代码管理更多菜单，显示如下:
![图3-11](./resources/git/12.png)
　　　
3. 鼠标移动到远程，显示如下:
![图3-12](./resources/git/13.png)
4. 根据用户的需求，点击相应的菜单;
5. 添加远程存储库菜单功能用于添加远程存储库;
6. 删除远程存储库菜单功能用于删除远程存储库。
　　
### 3.1.7、 存储菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击源代码管理更多菜单，显示如下:
![图3-13](./resources/git/14.png)
3. 鼠标移动到存储，显示如下:
![图3-14](./resources/git/15.png)
4. 根据用户的需求，点击相应的菜单;
5. 储藏菜单功能用于储藏文件;
6. 储藏（包含未追踪）菜单功能表示将包含未追踪的文件进行储藏;
7. 应用最新储藏菜单功能表示将储藏文件应用到当前分支;
8. 应用储藏...菜单功能表示将指定储藏文件应用到当前分支;
9. 弹出最新储藏菜单功能表示将储藏文件应用到当前分支，并删除该储藏文件;
10. 弹出储藏...菜单功能表示将指定储藏文件应用到当前分支，并删除该储藏文件;
11. 删除储藏菜单功能用于删除储藏文件。
　　
### 3.1.8、 标签菜单
1. 打开IDE后，点击侧边栏的或者快捷键ctrl+shift+G，打开源代码管理视图;
2. 点击源代码管理更多菜单，显示如下:
![图3-15](./resources/git/16.png)
3. 鼠标移动到标签，显示如下:
![图3-16](./resources/git/17.png)
4. 根据用户的需求，点击相应的菜单;
5. 创建标记菜单功能用于创建标签;
6. 删除标签菜单功能用于删除标签.

105
user-guide/files/简介.md
View File

@ -1,18 +1,37 @@
# 1. **Kylin-IDE**和**Kylin-Code**
- **Kylin-IDE**：面向银河麒麟操作系统V10的IDE产品，支持X86、ARM、LoongArch架构
* [IDE基础平台-仓库链接](https://gitee.com/chriswang521/kylin-ide)
* [IDE基础平台-下载链接](https://gitee.com/chriswang521/kylin-ide/releases)
- **Kylin-Code**：openKylin社区版本IDE，主要支持X86架构
* [IDE基础平台-仓库链接](https://gitee.com/openkylin/kylin-code)
* [IDE基础平台-下载链接](https://gitee.com/openkylin/kylin-code/releases)
- **Kylin-IDE**：目标是成为一款面向银河麒麟操作系统的通用集成开发环境软件和管理工具，让用户在银河麒麟操作系统上便捷地开发软件。按使用方式分为：桌面版、远程开发插件版、远程开发WebIDE版
* **桌面版**
- Kylin版“vscodium”，接入OpenVSX插件市场，插件管理器可便捷检索安装自研及优化插件，便于在银河麒麟系统上开发。
- [IDE基础平台-下载链接](https://gitee.com/chriswang521/kylin-ide/releases)
- 银河麒麟桌面操作系统V10亦可在软件商店中检索安装
- ![桌面版架构](./resources/brief/desktop.png)
* **远程开发插件版**
- 提供Kylin Remote Development插件，类微软Remote SSH（非完全开源），支持跨平台远程开发，兼容Kylin-IDE与VSCode
- 实现跨机器、跨平台远程开发，体验近似本地。例如可以在X86机器上连接LoongArch机器，开发LoongArch机器上的代码
- 支持无图形界面系统，如服务器环境
- 帮助文档：[链接](./远程开发.md)
- 插件：Kylin Remote Development插件可在插件市场中检索到，也可以在extensions-repo仓库中找到[下载链接](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam/remote-dev)
- 服务端：[下载链接](https://gitee.com/mcy-kylin/kylin-ide-server/releases)
- ![远程开发插件版架构](./resources/brief/remote-ext.png)
* **远程开发WebIDE版**
- WebIDE版：无需安装桌面版Kylin-IDE，通过浏览器实现远程开发，使用灵活。
- 跨平台远程开发：支持跨机器、跨架构远程开发，体验近似本地。
- 支持无图形界面系统：如服务器环境
- 帮助文档：[链接](./远程开发WebIDE版.md)
- 客户端：[下载链接](https://gitee.com/leven08/kylin-ide-web-client)
- 服务端：与远程开发插件版共用一套服务端
- ![远程开发WebIDE版架构](./resources/brief/web-ide.png)
- **Kylin-Code**：openKylin社区版本IDE
* [IDE基础平台-仓库链接](https://gitee.com/openkylin/kylin-code)
* [IDE基础平台-下载链接](https://gitee.com/openkylin/kylin-code/releases)
* openKylin系统亦可在软件商店中检索安装
# 2. 支持平台
见[支持的平台章节](./支持的平台.md)
# 3. 组成结构
- Kylin-IDE和Kylin-Code的组成结构相同，见下图，都包括IDE基础平台、插件管理器、插件仓库、插件，**注意，IDE基础平台仅是其中一个组成部分**
- ![总体架构图](./resources/brief/structure.png)
- **IDE基础平台**：fork 自微软Visual Studio Code(VSCode)开源项目 [Code OSS](https://github.com/microsoft/vscode)，仅提供基本图形界面和插件架构，开发功能需要插件配合
- Kylin-IDE有桌面版、远程开发插件版、远程开发WebIDE版等多种使用方式，Kylin-Code提供桌面版使用方式，但总体来说，其组成结构类似，都包括IDE基础平台(桌面版或服务版)、插件管理器、插件仓库、插件，**注意，IDE基础平台仅是其中一个组成部分**
- **IDE基础平台**：改造自微软Visual Studio Code(VSCode)开源项目 [Code OSS](https://github.com/microsoft/vscode)，仅提供基本图形界面和插件架构，开发功能需要插件配合
- **插件管理器**：分为在线插件管理器、离线插件管理器、插件依赖管理器
- **在线插件管理器**
- 集成在IDE基础平台中，检索、浏览、安装、卸载插件市场中的插件。[详细说明章节](./如何检索和安装插件.md)
@ -30,7 +49,7 @@
- **插件**
- **IDE基础平台仅提供基本图形界面和插件架构，多种编程语言的编辑、编译、调试等功能需要安装插件和插件依赖来完成**
- 安装和管理：使用插件管理器检索、安装、管理插件；使用插件依赖管理器管理插件依赖
- KylinIdeTeam目前开发适配了一批插件以满足一般开发需求，[见插件列表章节](./插件列表.md) 。**请优先使用我们开发适配的插件**，检索方法见下文
- KylinIdeTeam目前开发适配了一批插件以满足一般开发需求。**请优先使用我们开发适配的插件**，检索方法见下文
## 3.1 OpenVSX插件市场使用注意
- OpenVSX插件市场是一个开源插件市场，所有开发者都可以申请上传插件，插件数量较多。但并不是其中的所有插件都能正常使用，需要用户甄别
@ -45,37 +64,40 @@
- 同时，这些插件在openKylin社区[extensions-repo仓库](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam)提供插件汇总和手动下载链接
# 4. 桌面应用模式与远程开发模式
- **桌面应用模式**：与常见IDE一样，IDE基础平台以桌面应用软件形式安装运行
* 上文"1. Kylin-IDE和Kylin-Code"给出的IDE基础平台下载链接即为这种模式
- **远程开发模式**：类似微软闭源插件remote-ssh功能，IDE基础平台以远端服务形式安装运行，用户在本地通过SSH连接开发远程机器上的代码，体验和本地开发大体一致
* 远程开发模式需要插件（插件名称：Kylin remote development，插件ID：remote-dev，插件发布者xhafei）和服务端配合实现，插件会引导用户安装服务端
* 服务端下载地址：https://gitee.com/mcy-kylin/kylin-ide-server/releases
* 详细见[远程开发章节](./远程开发.md)
# 5. 使用方法
## 5.1 桌面应用模式
# 4. 使用方法
## 4.1 桌面版
- **安装IDE基础平台**
- Kylin-Code IDE基础平台
* 安装方式一：openKylin系统1.0版本已预装Kylin-Code
* 安装方式二：在openKylin系统的软件商店中找到Kylin-Code进行安装
* 安装方式三：[下载安装包](https://gitee.com/openkylin/kylin-code/releases)，然后后执行：sudo dpkg -i <file>.deb
* 安装方式一：在openKylin系统的软件商店中找到Kylin-Code进行安装
* 安装方式二：[下载安装包](https://gitee.com/openkylin/kylin-code/releases)，然后后执行：sudo dpkg -i <file>.deb
- Kylin-IDE IDE基础平台
* 根据平台[下载安装包](https://gitee.com/chriswang521/kylin-ide/releases)，然后后执行：sudo dpkg -i <file>.deb
* 安装方式一：在银河麒麟操作系统V10的软件商店中找到Kylin-IDE进行安装
* 安装方式二：根据平台[下载安装包](https://gitee.com/chriswang521/kylin-ide/releases)，然后后执行：sudo dpkg -i <file>.deb
- **下载安装插件依赖管理器**
* 插件名称：extension dependency，发布者：KylinIdeTeam
* 安装方式一：通过在线插件检索，从OpenVSX插件市场中安装，见下图：点击插件视图中的插件筛选器图标，选择Kylin-IDE(KylinCode)插件分类->插件管理器
- ![插件依赖管理器OpenVSX安装](./resources/extension-dependency/search.gif)
* 安装方式二：或手动在openKylin的[extensions-repo仓库中](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam/)找到并下载安装插件
- **下载安装插件**
* 安装方式一：通过在线检索，从OpenVSX插件市场中安装，方法见上文
* 安装方式二：或手动在openKylin的extensions-repo中找到并下载安装插件
* Kylin-IDE（KylinCode）插件分类菜单检索到的插件是KylinIdeTeam开发、适配的插件
* 根据开发需求选择检索分类
- **使用插件依赖管理器检查、安装插件依赖**
* 点击菜单中的帮助->打开插件依赖管理器进入插件依赖管理器页面
* 详细见[插件依赖管理章节](./插件依赖管理.md)
- **快速安装插件和系统依赖软件**
* 提供开发环境快速部署功能，将基础的插件和系统依赖以选项方式提供给用户
* 开发环境快速部署入口
- 安装后第一次使用时
- 帮助菜单“打开开发环境快速部署”
* ![在OpenVSX插件市场中找到我们开发适配的插件](./resources/brief/fast-deploy-env.png)
- **手动安装插件和系统依赖软件**
- **下载安装插件**
* 安装方式一：通过在线检索，从OpenVSX插件市场中安装，方法见上文
* 安装方式二：或手动在openKylin的extensions-repo中找到并下载安装插件
* Kylin-IDE（KylinCode）插件分类菜单检索到的插件是KylinIdeTeam开发、适配的插件
* 根据开发需求选择检索分类
- **使用插件依赖管理器检查、安装插件依赖**
* 点击菜单中的帮助->打开插件依赖管理器进入插件依赖管理器页面
* 详细见[插件依赖管理章节](./插件依赖管理.md)
- **开始开发工作**
* 如果是新手，可以安装Kylin Project Manager插件（项目创建管理插件），创建简单项目，在此基础上进行开发。[详细见项目管理章节](./项目管理.md)
* 也可以打开一个项目文件夹，开始编辑工作（已安装对应编程语言的支持插件和依赖）；配置task.json、launch.json，运行和调试
@ -92,15 +114,8 @@
sudo dpkg -P xxxx
```
## 5.2 远程开发模式
- **按照桌面应用模式安装IDE基础平台、插件依赖管理器**
- **下载安装远程开发插件**（插件名称：Kylin remote development，插件ID：remote-dev，插件发布者xhafei）
* 安装方式一：通过在线插件检索，从OpenVSX插件市场中安装
* 安装方式二：或手动在openKylin的extensions-repo仓库中找到并下载安装插件
- **输入、配置远程机器的用户名、IP等信息，自动或根据提示安装服务端，输入远程SSH密码**
- **在远程端下载安装插件依赖管理器**
- **在远程端下载安装插件**
- **在远程端使用插件依赖管理器检查、安装插件依赖**
- **开始远程开发工作**
- 卸载：卸载远程开发插件，卸载远程服务端
- 详细见[远程开发章节](./远程开发.md)
## 4.2 远程开发插件版
- 详细见[远程开发插件版章节](./远程开发.md)
## 4.3 远程开发WebIDE版
- 详细见[远程开发WebIDE版章节](./远程开发WebIDE版.md)

0
user-guide/files/远程开发客户端.md → user-guide/files/远程开发WebIDE版.md
View File

15
user-guide/目录.md
View File

@ -1,11 +1,13 @@
# 目录
#### [简介](./files/简介.md)
#### [支持的平台](./files/支持的平台.md)
#### [新功能介绍](./files/新功能.md)
#### [插件列表](./files/插件列表.md)
#### [支持的平台](./files/支持的平台.md)
#### [远程开发WebIDE版](./files/远程开发客户端.md)
#### [远程开发插件版](./files/远程开发.md)
#### [IDE基础平台](./files/IDE基础平台.md)
@ -17,11 +19,6 @@
#### [项目管理](./files/项目管理.md)
#### [版本管理工具](./files/版本管理工具.md)
#### [远程开发](./files/远程开发.md)
#### [远程开发客户端](./files/远程开发客户端.md)
#### [Qt开发](./files/Qt开发.md)
#### [C-C++开发](./files/C-C++开发.md)
@ -36,8 +33,6 @@
#### [死锁检测](./files/死锁检测.md)
#### [打包](./files/打包.md)
#### [历史调试](./files/历史调试.md)
#### [问题反馈](./files/问题反馈.md)