diff --git a/user-guide/files/resources/brief/structure.png b/user-guide/files/resources/brief/structure.png new file mode 100644 index 0000000000000000000000000000000000000000..83f2c63646272b5c4a48d09c072ac4d91f62a243 Binary files /dev/null and b/user-guide/files/resources/brief/structure.png differ diff --git "a/user-guide/files/\346\217\222\344\273\266\345\210\227\350\241\250.md" "b/user-guide/files/\346\217\222\344\273\266\345\210\227\350\241\250.md" new file mode 100644 index 0000000000000000000000000000000000000000..9b955c6d364e459535a9cbf02624011b59f6ba8f --- /dev/null +++ "b/user-guide/files/\346\217\222\344\273\266\345\210\227\350\241\250.md" @@ -0,0 +1,181 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KylinIdeTeam开发适配的插件列表
序号功能是否必装插件展示名称插件ID链接
1远程开发可选，服务器系统仅支持远程开发模式Kylin remote developmentxhafei.remote-dev链接
2插件依赖管理器必装extension dependencyKylinIdeTeam.extension-dependency链接
3离线插件管理器可选offline extensions managerKylinIdeTeam.offline-extensions-manager链接
4git增强可选Gitlens lower version for friendly licenceKylinIdeTeam.gitlens链接
5项目创建；目前支持C/C++、部分Java项目创建可选Kylin Project ManagerKylinIdeTeam.project-manager链接
6C/C++编辑C/C++开发必装Clangd（semantic highlighting for clangd8 and for KylinOS）KylinIdeTeam.vscode-clangd链接
7C/C++调试C/C++开发必装Native Debug(fix some bugs)KylinIdeTeam.debug链接
8cmake文件编辑支持可选CMake IntelliSenceKylinIdeTeam.cmake-intellisence链接
9Python编辑和调试Python开发必装Python（with jedi language server）KylinIdeTeam.python链接
10Java插件集合包，可以把下面列出的Java支持插件都安装上可选Java Pack (Support openjdk11 runtime)KylinIdeTeam.vscode-java-pack链接
11Java编辑Java开发必装Java (Support openjdk11 runtime)KylinIdeTeam.java链接
12Java调试Java开发必装Java Debug (Support openjdk11 runtime)KylinIdeTeam.vscode-java-debug链接
13Java项目管理使用可选Java Dependency (Support openjdk11 runtime)KylinIdeTeam.vscode-java-dependency链接
14Java项目管理使用，Run & Debug JUnit/TestNG Test Cases可选Java Test (Support openjdk11 runtime)KylinIdeTeam.vscode-java-test链接
15Java项目管理使用，maven支持可选Java Maven (Support openjdk11 runtime)KylinIdeTeam.vscode-maven链接
16Java项目管理使用，gradle支持可选Java Gradle (Support openjdk11 runtime)KylinIdeTeam.vscode-gradle链接
17Go编辑和调试Go开发必装Go（for KylinOS）KylinIdeTeam.go链接
18历史调试可选historyDebugKylinIdeTeam.historydebug链接
19死锁检测可选deadlock-detectKylinIdeTeam.deadlock-detect链接
\ No newline at end of file diff --git "a/user-guide/files/\346\217\222\344\273\266\345\210\227\350\241\250.xlsx" "b/user-guide/files/\346\217\222\344\273\266\345\210\227\350\241\250.xlsx" new file mode 100644 index 0000000000000000000000000000000000000000..a26620fd73f33bc4d650674e4ea8c322db1d5bc5 Binary files /dev/null and "b/user-guide/files/\346\217\222\344\273\266\345\210\227\350\241\250.xlsx" differ diff --git "a/user-guide/files/\346\224\257\346\214\201\347\232\204\345\271\263\345\217\260.md" "b/user-guide/files/\346\224\257\346\214\201\347\232\204\345\271\263\345\217\260.md" index 9312edddd07947882953c5a004fc932d33b885a4..b572724a3841529c80979a75da432f1fc1a483ae 100644 --- "a/user-guide/files/\346\224\257\346\214\201\347\232\204\345\271\263\345\217\260.md" +++ "b/user-guide/files/\346\224\257\346\214\201\347\232\204\345\271\263\345\217\260.md" @@ -1,11 +1,13 @@ # 支持的平台 -- Kylin-Code - * CPU架构：X86_64 - * 操作系统：openKylin - * 建议内存：>= 8G - * 建议存储空间：>= 5G - Kylin-IDE - * CPU架构：X86_64、ARM、LoongArch - * 操作系统：在以下版本系统做了基本测试，银河麒麟桌面操作系统 V10 SP1(2203)、银河麒麟服务器操作系统 V10 SP3 - * 建议内存：>= 8G - * 建议存储空间：>= 5G \ No newline at end of file + * 支持X86、ARM、LoongArch架构 + * 支持银河麒麟桌面操作系统V10（桌面应用模式、远程开发模式） + * 支持银河麒麟服务器操作系统V10（仅远程开发模式） + * 建议内存：>= 8G + * 建议剩余存储空间：>= 5G +- Kylin-Code + * 支持X86架构 + * 支持openKylin系统（桌面应用模式、远程开发模式） + * 通过远程开发模式，安装openKylin系统的机器可以作为本地开发机，远程开发X86、ARM、LoongArch架构、银河麒麟操作系统V10机器上的代码 + * 建议内存：>= 8G + * 建议剩余存储空间：>= 5G \ No newline at end of file diff --git "a/user-guide/files/\347\256\200\344\273\213.md" "b/user-guide/files/\347\256\200\344\273\213.md" index cf358cc6475bbf3cb6978ee957b3957f3841bae2..e46d75b019562a696f41374ac207159f15295098 100644 --- "a/user-guide/files/\347\256\200\344\273\213.md" +++ "b/user-guide/files/\347\256\200\344\273\213.md" @@ -1,42 +1,101 @@ -# 简介 -- **Kylin-Code**：openKylin社区版本IDE，主要支持X86架构；**Kylin-IDE**：面向银河麒麟操作系统V10的IDE产品，支持X86、ARM、LoongArch架构。目前，Kylin-Code和Kylin-IDE同步迭代开发中，功能基本一致，都接入了OpenVSX插件市场。Kylin-IDE现阶段版本也会在[openKylin社区发布](https://gitee.com/openkylin/extensions-repo)，欢迎大家试用反馈。 -- 组成结构包括IDE基础平台、插件、插件仓库等内容，目标是让用户在openKylin或银河麒麟操作系统上便捷地开发软件，目前正在迭代开发中。 -- 最新版本IDE基础平台和插件获取地址：https://gitee.com/openkylin/extensions-repo/tree/master -- 使用场景 - * 使用场景一：简称桌面版IDE，在单台台式机上开发程序。这种场景下，通常使用桌面版IDE基础平台+插件的形式进行开发。这种场景下，目前在86架构、openKylin操作系统和X86、ARM、LoongArch架构、银河麒麟桌面操作系统V10 SP1(2203)上做了基本测试 - * 使用场景二：简称远程开发，提供类似微软闭源插件remote-ssh的开发方式，在一台机器上使用插件或浏览器作为客户端，通过客户端在远程机器上部署一个IDE基础平台服务，客户端和服务端之间利用ssh连接进行通信。这种场景目前在86架构、openKylin操作系统和X86、ARM、LoongArch架构、银河麒麟桌面操作系统V10 SP1(2203)、银河麒麟服务器操作系统V10 SP3上做了基本测试 -- IDE基础平台基于开源项目Code-OSS（1.68.0），默认接入OpenVSX插件商店。我们适配、开发的插件会上传至OpenVSX插件商店，可以通过IDE基础平台定制的插件分类搜索菜单检索到我们的插件；也会上传至openKylin社区的extensions-repo中。 -## 安装 -- 桌面版IDE - ```sh - sudo dpkg -i .deb - ``` -- 远程开发 +# 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) + +# 2. 支持平台 +见[支持的平台章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E6%94%AF%E6%8C%81%E7%9A%84%E5%B9%B3%E5%8F%B0.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)，仅提供基本图形界面和插件架构，开发功能需要插件配合 + - **插件管理器**：分为在线插件管理器、离线插件管理器、插件依赖管理器 + - **在线插件管理器** + - 集成在IDE基础平台中，检索、浏览、安装、卸载插件市场中的插件。[详细说明章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E5%A6%82%E4%BD%95%E6%A3%80%E7%B4%A2%E5%92%8C%E5%AE%89%E8%A3%85%E6%8F%92%E4%BB%B6.md) + - **离线插件管理器** + - IDE基础平台集成了一部分功能，可以离线安装vsix插件文件；还有一部分功能以插件形式提供，可以预览、分类安装vsix插件文件集合。[详细说明章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E7%A6%BB%E7%BA%BF%E6%8F%92%E4%BB%B6%E7%AE%A1%E7%90%86.md) + - **插件依赖管理器** + - 插件正常运行有时需要调用操作系统软件，这些操作系统软件称之为插件依赖 + - 不同架构、不同版本系统的插件依赖名称、版本可能不同，安装可能会给用户带来困惑 + - 为简化操作，可以使用本插件来处理插件依赖的检查和安装 + - **仅对KylinIdeTeam适配开发的插件有效（配置了depends.json文件）** + - [详细说明章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E6%8F%92%E4%BB%B6%E4%BE%9D%E8%B5%96%E7%AE%A1%E7%90%86.md) + - **插件仓库** + - 目前默认接入OpenVSX插件市场 + - 在openKylin社区[extensions-repo仓库](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam)提供插件汇总和手动下载链接 + - **插件** + - **IDE基础平台仅提供基本图形界面和插件架构，多种编程语言的编辑、编译、调试等功能需要安装插件和插件依赖来完成** + - 安装和管理：使用插件管理器检索、安装、管理插件；使用插件依赖管理器管理插件依赖 + - KylinIdeTeam目前开发适配了一批插件以满足一般开发需求，[见插件列表章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8.md) 。**请优先使用我们开发适配的插件**，检索方法见下文 + +## 3.1 OpenVSX插件市场使用注意 +- OpenVSX插件市场是一个开源插件市场，所有开发者都可以申请上传插件，插件数量较多。但并不是其中的所有插件都能正常使用，需要用户甄别 +- 我们提供了一种检索方式，能够在OpenVSX插件市场中检索到我们开发适配的插件，这些插件满足基本开发需求，并经过了我们的测试，**请优先使用我们开发适配的插件** + * 检索方法见下图：点击插件视图中的插件筛选器图标，选择Kylin-IDE(或KylinCode)插件分类 + * ![在OpenVSX插件市场中找到我们开发适配的插件](./resources/useExtensions/find-our-ext.jpg) +- 同时，这些插件在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 + * 详细见[远程开发章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E8%BF%9C%E7%A8%8B%E5%BC%80%E5%8F%91.md) + +# 5. 使用方法 + +## 5.1 桌面应用模式 +- **安装IDE基础平台** + - Kylin-Code IDE基础平台 + * 安装方式一：openKylin系统1.0版本已预装Kylin-Code + * 安装方式二：在openKylin系统的软件商店中找到Kylin-Code进行安装 + * 安装方式三：[下载安装包](https://gitee.com/openkylin/kylin-code/releases)，然后后执行：sudo dpkg -i .deb + - Kylin-IDE IDE基础平台 + * 根据平台[下载安装包](https://gitee.com/chriswang521/kylin-ide/releases)，然后后执行：sudo dpkg -i .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开发、适配的插件 + * 根据开发需求选择检索分类 +- **使用插件依赖管理器检查、安装插件依赖** + * 点击菜单中的帮助->打开插件依赖管理器进入插件依赖管理器页面 + * 详细见[插件依赖管理章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E6%8F%92%E4%BB%B6%E4%BE%9D%E8%B5%96%E7%AE%A1%E7%90%86.md) +- **开始开发工作** + * 如果是新手，可以安装Kylin Project Manager插件（项目创建管理插件），创建简单项目，在此基础上进行开发。[详细见项目管理章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86.md) + * 也可以打开一个项目文件夹，开始编辑工作（已安装对应编程语言的支持插件和依赖）；配置task.json、launch.json，运行和调试 + - 以C语言为例，[详细见C-C++开发章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/C-C++%E5%BC%80%E5%8F%91.md) +- 卸载 ```sh - 在桌面版IDE上安装远程开发插件（remote-dev），按照插件提示下载配置服务端 - ``` -## 启动 -- 桌面版IDE - * 开始菜单启动 - - 用户可通过点击操作系统图形界面左下角的开始菜单，选择Kylin-IDE(Kylin-Code)图标，或搜索并选择Kylin-IDE(Kylin-Code)，以启动软件。 - - * 命令行启动 - - 打开一个系统终端，输入“kylin-ide”(或者“kylin-code”)，以启动软件。以root用户身份启动时，输入“kylin-ide --user-data-dir=xxx”，xxx表示一个已经存在的临时工作目录。 -- 远程开发 - * 在桌面版IDE上安装远程开发插件（remote-dev），按照插件提示下载配置服务端，按插件提示进行远程连接，详见远程开发章节。 -## 停止和挂起 -点击IDE图形界面右上方的最小化按钮，可将图形界面最小化。点击图形界面右上方的❌号按钮，可关闭图形界面。 -## 卸载 -- 桌面版IDE - ```sh //卸载kylin-ide命令如下: sudo dpkg -r kylin-ide //卸载kylin-code命令如下： sudo dpkg -r kylin-code - ``` -- 远程开发 - - 卸载远程开发插件，服务端卸载删除方法见远程开发章节。 \ No newline at end of file + + //将配置目录、已安装插件文件全部删除 + sudo dpkg -P xxxx + ``` + +## 5.2 远程开发模式 +- **按照桌面应用模式安装IDE基础平台、插件依赖管理器** +- **下载安装远程开发插件**（插件名称：Kylin remote development，插件ID：remote-dev，插件发布者xhafei） + * 安装方式一：通过在线插件检索，从OpenVSX插件市场中安装 + * 安装方式二：或手动在openKylin的extensions-repo仓库中找到并下载安装插件 +- **输入、配置远程机器的用户名、IP等信息，自动或根据提示安装服务端，输入远程SSH密码** + * 详细见[用户远程开发章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E8%BF%9C%E7%A8%8B%E5%BC%80%E5%8F%91.md) +- **在远程端下载安装插件依赖管理器** +- **在远程端下载安装插件** +- **在远程端使用插件依赖管理器检查、安装插件依赖** +- **开始远程开发工作** +- 卸载：卸载远程开发插件，卸载远程服务端，详细见[远程开发章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E8%BF%9C%E7%A8%8B%E5%BC%80%E5%8F%91.md) \ No newline at end of file diff --git "a/user-guide/files/\351\227\256\351\242\230\345\217\215\351\246\210.md" "b/user-guide/files/\351\227\256\351\242\230\345\217\215\351\246\210.md" index ea10f7ef2e7785446af17741c8fa261db3f4b173..bc4835128eb68e2048751688b7fe8f1a52462507 100644 --- "a/user-guide/files/\351\227\256\351\242\230\345\217\215\351\246\210.md" +++ "b/user-guide/files/\351\227\256\351\242\230\345\217\215\351\246\210.md" @@ -1,3 +1,4 @@ -- 如果发现问题，可以在openKylin社区extensions-repo仓库、kylin-code仓库或对应仓库的Issues中进行反馈。 - * extensions-repo仓库issues地址链接：https://gitee.com/openkylin/extensions-repo/issues - * kylin-code仓库issues地址链接：https://gitee.com/openkylin/kylin-code/issues \ No newline at end of file +- 如果发现问题，相应仓库的Issues中反馈问题，常用的几个Issues链接如下 + * [extensions-repo Issues](https://gitee.com/openkylin/extensions-repo/issues) + * [Kylin-Code IDE基础平台 Issues](https://gitee.com/openkylin/kylin-code/issues) + * [Kylin-IDE IDE基础平台 Issues](https://gitee.com/chriswang521/kylin-ide/issues) \ No newline at end of file diff --git "a/user-guide/\347\233\256\345\275\225.md" "b/user-guide/\347\233\256\345\275\225.md" index f42fa1bdb71407ca74b9e2c203316b84e31e864a..fb406d94fc51f4ba5c72cbf0eb528cbe00461742 100644 --- "a/user-guide/\347\233\256\345\275\225.md" +++ "b/user-guide/\347\233\256\345\275\225.md" @@ -3,6 +3,8 @@ #### [支持的平台](./files/支持的平台.md) +#### [插件列表](./files/插件列表.md) + #### [IDE基础平台](./files/IDE基础平台.md) #### [如何检索和安装插件](./files/如何检索和安装插件.md)