From c8dc3d5df78b8a98150c1e9beec86f8643683bee Mon Sep 17 00:00:00 2001 From: muruichao Date: Fri, 13 Sep 2024 02:06:54 +0000 Subject: [PATCH 1/4] update README.md. Signed-off-by: muruichao --- README.md | 135 +++++++++++++----------------------------------------- 1 file changed, 31 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index a5006911..2007fb9f 100644 --- a/README.md +++ b/README.md @@ -1,114 +1,41 @@ # Kylin-Code -- 基于VSCode开源项目，面向国产平台，支持多种编程语言的编辑、构建、调试，支持本地开发和远程开发的集成开发环境。未来将逐步丰富开发解决方案，致力于麒麟生态建设 +- Kylin版“VSCodium”，面向国产平台，支持多种编程语言的编辑、构建、调试，支持本地开发和远程开发的集成开发环境。未来将逐步丰富开发解决方案，致力于麒麟生态建设 + +## Kylin-Code与Kylin-IDE - **Kylin-Code**：openKylin社区版本IDE，主要支持X86架构。本仓库是其组成部分中的IDE基础平台，基于VSCode开源项目Code-OSS -- **Kylin-IDE**：面向银河麒麟操作系统V10的IDE产品，支持X86、ARM、LoongArch架构 -- 目前，Kylin-Code和Kylin-IDE同步迭代开发中，功能基本一致，都默认接入了OpenVSX插件市场 - -## 链接地址 -- **Kylin-Code** - * [IDE基础平台-仓库链接](https://gitee.com/openkylin/kylin-code) - * [IDE基础平台-下载链接](https://gitee.com/openkylin/kylin-code/releases) - * [项目计划](https://gitee.com/openkylin/kylin-code/wikis/%E9%A1%B9%E7%9B%AE%E8%AE%A1%E5%88%92) -- **Kylin-IDE** - * [IDE基础平台-仓库链接](https://gitee.com/chriswang521/kylin-ide) - * [IDE基础平台-下载链接](https://gitee.com/chriswang521/kylin-ide/releases) -- [汇总仓库：openKylin extensions-repo](https://gitee.com/openkylin/extensions-repo) - * [插件手动下载地址(KylinIDETeam目录)](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam) - * [用户帮助文档地址(user-guide目录)](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/%E7%9B%AE%E5%BD%95.md) -- openKylin Framework SIG组月度例会 - * 欢迎参加月度例会，讨论Kylin-Code及其插件规划和发展思路、讨论IDE发展方向 - * 例会时间：每个月的第2个周二下午14:00，如遇到节假日，顺延到下一个周二 - * 例会会议号会在openKylin官网公布（[点此链接，在主页找到“社区日程”，点击日历的对应日期查看](https://www.openkylin.top/index-cn.html)） - -## 新增功能介绍 -- **开发环境快速部署** - * 用于引导用户根据开发场景安装基础功能插件、安装依赖软件、配置基本开发环境。 - * 支持在线安装，需要连接互联网下载插件和依赖软件 - * 仅支持Openkylin X86操作系统 - * 安装使用 - - 安装Kylin-Code v0.4.0或0.4.0以上版本 - - Kylin-Code首次启动显示开发环境快速部署界面，非首次启动点击菜单栏中的帮助->打开开发环境快速部署显示开发环境快速部署界面 - - ![开发环境快速部署界面](./imgs/readme-img/instGuide_1.jpg) - - 根据提示选择开发场景，进行插件和依赖软件下载安装，配置基本开发环境 - - ![开发场景](./imgs/readme-img/instGuide_2.jpg) - - 详细见[用户帮助文档相关章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/新功能.md) - -## Kylin-Code支持的平台 -- 支持X86架构 -- 支持openKylin系统（桌面应用模式、远程开发模式） -- 通过安装远程开发插件，安装openKylin系统的机器可以作为本地开发机，远程开发X86、ARM、LoongArch架构、银河麒麟操作系统V10机器上的代码 + * [IDE基础平台-仓库链接](https://gitee.com/openkylin/kylin-code) + * [IDE基础平台-下载链接](https://gitee.com/openkylin/kylin-code/releases) + * [项目计划](https://gitee.com/openkylin/kylin-code/wikis/%E9%A1%B9%E7%9B%AE%E8%AE%A1%E5%88%92) +- **Kylin-IDE**：面向银河麒麟操作系统V10的IDE，按使用方式分为桌面版、远程开发插件版、远程开发WebIDE版 + * [简介和链接](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E7%AE%80%E4%BB%8B.md) + +## 帮助文档 +- [帮助文档](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/%E7%9B%AE%E5%BD%95.md) +- [汇总仓库(openKylin extensions-repo)](https://gitee.com/openkylin/extensions-repo) +- [插件手动下载地址(extensions-repo KylinIDETeam目录)](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam) + +## openKylin Framework SIG组月度例会 + * 欢迎参加月度例会，讨论Kylin-Code及其插件规划和发展思路、讨论IDE发展方向 + * 例会时间：每个月的第2个周二下午14:00，如遇到节假日，顺延到下一个周二 + * 例会会议号会在openKylin官网公布（[点此链接，在主页找到“社区日程”，点击日历的对应日期查看](https://www.openkylin.top/index-cn.html)） + +## 支持的平台 +- 见[帮助文档支持的平台章节](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) + +## 新功能介绍 +- 见[帮助文档新功能章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E6%96%B0%E5%8A%9F%E8%83%BD.md) ## 组成 -- **Kylin-Code**整体上由4部分组成，如下图所示，包括IDE基础平台、插件管理器、插件、插件仓库。**本仓库仅是Kylin-Code的其中一个组成部分：IDE基础平台** - * ![总体架构图](./imgs/readme-img/kylin-code-structure.png) -- **仅安装IDE基础平台只能完成很有限的编辑功能，需要安装插件并在操作系统上安装插件依赖才能实现更多的开发功能** -- **IDE基础平台提供基本图形界面、插件架构，用户通过插件管理器检索、安装、管理插件，通过插件依赖管理器安装插件依赖** -- 本仓库（IDE基础平台）fork 自微软Visual Studio Code(VSCode)开源项目 [Code OSS](https://github.com/microsoft/vscode) ，默认接入 [OpenVSX](https://open-vsx.org/) 插件市场 - -## 桌面应用模式与远程开发模式 -- **桌面应用模式** - * 与常见IDE一样，IDE基础平台以桌面应用软件形式安装运行 - * [本仓库的kylin-code](https://gitee.com/openkylin/kylin-code/releases)即为这种模式 -- **远程开发模式** - * 类似微软闭源的Remote SSH功能，IDE基础平台以远端服务形成安装运行，用户在本地通过SSH连接开发远程机器上的代码，体验和本地开发大体一致 - * 远程开发模式需要先安装插件（插件名称：Kylin remote development，插件ID：remote-dev），插件会根据远程的目标机器自动部署服务端或引导用户安装服务端 - * 通过安装远程开发插件，安装openKylin系统的机器可以作为本地开发机，远程开发X86、ARM、LoongArch架构、银河麒麟操作系统V10机器上的代码 - * [插件手动下载地址](https://gitee.com/mcy-kylin/remote-dev/releases)；亦可在OpenVSX插件市场中下载使用 - * [服务端手动下载地址](https://gitee.com/mcy-kylin/kylin-ide-server/releases) +- 见[帮助文档简介章节桌面版](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E7%AE%80%E4%BB%8B.md) +- 仅安装IDE基础平台只能完成很有限的编辑功能，需要安装插件并在操作系统上安装插件依赖才能实现更多的开发功能 +- IDE基础平台提供基本图形界面、插件架构，通过插件管理器检索、安装、管理插件，通过插件依赖管理器安装插件依赖 +- IDE基础平台基于Visual Studio Code(VSCode)开源项目 [Code OSS](https://github.com/microsoft/vscode) ，默认接入 [OpenVSX](https://open-vsx.org/) 插件市场 ## 使用方法 - -### 桌面应用模式 -- **安装IDE基础平台** - * 安装方式一：openKylin系统1.0版本已预装Kylin-Code - * 安装方式二：在openKylin系统的软件商店中找到Kylin-Code进行安装 - * 安装方式三：[下载安装包](https://gitee.com/openkylin/kylin-code/releases)，然后后执行：sudo dpkg -i .deb -- **下载安装插件依赖管理器** - * 插件名称：extension dependency，发布者：KylinIdeTeam - * 安装方式一：通过在线插件检索，从OpenVSX插件市场中安装，见下图：点击插件视图中的插件筛选器图标，选择Kylin-IDE(Kylin-Code)插件分类->插件管理器 - - ![插件依赖管理器OpenVSX安装](./imgs/readme-img/search.gif) - * 安装方式二：或手动在openKylin的[extensions-repo仓库中](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam/)找到并下载安装插件 -- **下载安装插件** - * 安装方式一：通过在线检索，从OpenVSX插件市场中安装，方法见上文 - * 安装方式二：或手动在openKylin的extensions-repo中找到并下载安装插件 - * Kylin-IDE（Kylin-Code）插件分类菜单检索到的插件是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语言为例，[详细见用户帮助文档相关章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/C-C++%E5%BC%80%E5%8F%91.md) - -### 远程开发模式 -- **在安装了openKylin系统的机器上，按照桌面应用模式安装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/%E7%AE%80%E4%BB%8B.md#4-) ## OpenVSX插件市场使用注意 -- OpenVSX插件市场是一个开源插件市场，所有开发者都可以申请上传插件，插件数量较多。但并不是其中的所有插件都能正常使用，需要用户甄别 -- 我们提供了一种检索方式，能够在OpenVSX插件市场中检索到我们开发适配的插件，满足基本开发需求，**请优先使用我们开发适配的插件** - * 检索方法见下图：点击插件视图中的插件筛选器图标，选择Kylin-Code(Kylin-IDE)插件分类 - * ![在OpenVSX插件市场中找到我们开发适配的插件](./imgs/readme-img/find-our-ext.jpg) - -## 特色功能 -- **[远程开发](#远程开发模式)** - * 微软闭源的Remote SSH插件，仅在VSCode中能够正常运行，不支持LoongArch架构 - * Kylin remote development插件可以在Kylin-Code、Kylin-IDE、Code-OSS、VSCodium、VSCode中正常运行，支持X86、ARM、LoongArch架构，LoongArch架构上的远程开发可以使用本功能 - * 如果有其他架构的支持需要，可以在Issues中提出 - * 详细见[用户帮助文档相关章节](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/%E5%8E%86%E5%8F%B2%E8%B0%83%E8%AF%95.md) - +- 见[帮助文档简介章节，OpenVSX插件市场使用注意小节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E7%AE%80%E4%BB%8B.md#31-openvsx) # 常见问题 @@ -125,7 +52,7 @@ - 为什么不使用最新版本 - 目前版本基于Code-OSS1.68.0版本进行改造，之所以不使用最新版本，主要基于以下原因 + 目前版本基于Code-OSS1.85.2版本进行改造，之所以不使用最新版本，主要基于以下原因 * 第一，Code-OSS代码迭代较快，通常2周发布一个版本，紧跟Code-OSS版本不太现实。 * 第二，我们希望在多个国产平台上保持版本基本一致，Code-OSS依赖的Electron移植适配工作量较大，特别是LoongArch等国产平台，需要基于现有Electron版本或投入大量精力移植适配某个版本。 * 第三，为用户在openKylin等国产操作系统上开发软件提供一个稳定好用的IDE是我们所要追求的目标。 -- Gitee From 5008141cedab0319660eaac81772ba11e313cc89 Mon Sep 17 00:00:00 2001 From: muruichao Date: Fri, 13 Sep 2024 02:10:21 +0000 Subject: [PATCH 2/4] update README.md. Signed-off-by: muruichao --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2007fb9f..592e3d8e 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,15 @@ ## 支持的平台 - 见[帮助文档支持的平台章节](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) -## 新功能介绍 -- 见[帮助文档新功能章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E6%96%B0%E5%8A%9F%E8%83%BD.md) - ## 组成 - 见[帮助文档简介章节桌面版](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E7%AE%80%E4%BB%8B.md) - 仅安装IDE基础平台只能完成很有限的编辑功能，需要安装插件并在操作系统上安装插件依赖才能实现更多的开发功能 - IDE基础平台提供基本图形界面、插件架构，通过插件管理器检索、安装、管理插件，通过插件依赖管理器安装插件依赖 - IDE基础平台基于Visual Studio Code(VSCode)开源项目 [Code OSS](https://github.com/microsoft/vscode) ，默认接入 [OpenVSX](https://open-vsx.org/) 插件市场 +## 新功能介绍 +- 见[帮助文档新功能章节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E6%96%B0%E5%8A%9F%E8%83%BD.md) + ## 使用方法 - 见[帮助文档简介章节，使用方法小节](https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E7%AE%80%E4%BB%8B.md#4-) -- Gitee From 7b7b6e3d285e46c6f218d35a5af7227afb1da2e0 Mon Sep 17 00:00:00 2001 From: muruichao Date: Fri, 13 Sep 2024 02:11:46 +0000 Subject: [PATCH 3/4] update README.md. Signed-off-by: muruichao --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 592e3d8e..1deb440f 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,9 @@ - 如何加入Framework SIG组，一起思考、推进国产IDE的发展 1. 在相关仓库反馈issues，[仓库列表](https://gitee.com/openkylin/community/tree/master/sig/framework#repository) - 2. 参与开发：您可以直接在我们的[仓库列表](https://gitee.com/openkylin/community/tree/master/sig/framework#repository)中 fork 自己的感兴趣的项目，提交pr。 - 3. 成为 Maintainer：您可以直接向目前的任何一个[Maintainer](https://gitee.com/openkylin/community/tree/master/sig/framework#maintainers)提出申请，在获得超过半数的 Maintainer 的支持之后，我们正式吸纳您成为 Framework SIG 的 Maintainer。 + 2. 参与开发：您可以直接在我们的[仓库列表](https://gitee.com/openkylin/community/tree/master/sig/framework#repository)中 fork 自己的感兴趣的项目，提交pr + 3. 成为 Maintainer：您可以直接向目前的任何一个[Maintainer](https://gitee.com/openkylin/community/tree/master/sig/framework#maintainers)提出申请，在获得超过半数的 Maintainer 的支持之后，我们正式吸纳您成为 Framework SIG 的 Maintainer + 4. 参加openKylin Framework SIG组月度例会，例会时间见上文 # 构建步骤 -- Gitee From 0d83aa6d337d3f06e4e6e5e9cb92df977936450d Mon Sep 17 00:00:00 2001 From: muruichao Date: Fri, 13 Sep 2024 02:12:18 +0000 Subject: [PATCH 4/4] update README.md. Signed-off-by: muruichao --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1deb440f..cdb911a4 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ - 如何加入Framework SIG组，一起思考、推进国产IDE的发展 1. 在相关仓库反馈issues，[仓库列表](https://gitee.com/openkylin/community/tree/master/sig/framework#repository) 2. 参与开发：您可以直接在我们的[仓库列表](https://gitee.com/openkylin/community/tree/master/sig/framework#repository)中 fork 自己的感兴趣的项目，提交pr - 3. 成为 Maintainer：您可以直接向目前的任何一个[Maintainer](https://gitee.com/openkylin/community/tree/master/sig/framework#maintainers)提出申请，在获得超过半数的 Maintainer 的支持之后，我们正式吸纳您成为 Framework SIG 的 Maintainer + 3. 成为 Maintainer：您可以直接向目前的任何一个[Maintainer](https://gitee.com/openkylin/community/tree/master/sig/framework#maintainers)提出申请，在获得超过半数的 Maintainer 的支持之后，我们正式吸纳您成为 Framework SIG 的 Maintainer 4. 参加openKylin Framework SIG组月度例会，例会时间见上文 # 构建步骤 -- Gitee