修改部分用户帮助文档描述,替换一个图片

This commit is contained in:
muruichao 2023-05-19 10:35:43 +08:00
parent 686e141f0f
commit f0c40454e8
3 changed files with 29 additions and 22 deletions

View File

@ -40,7 +40,7 @@
- 方式二插件商店查找并安装插件管理插件extension dependency,插件安装后调用命令打开插件管理页面查找clangd插件相关依赖进行安装具体操作详情见[插件依赖管理](插件依赖管理.md)
### 1.3 安装QT相关依赖
## 1.3 安装QT相关依赖
用户如果编译QT程序可通过以下命令安装QT相关依赖包
@ -56,7 +56,7 @@
sudo apt install qtbase5-dev
```
### 1.2.4 C/C++相关插件安装
## 1.4 C/C++相关插件安装
- Kylin-clangd插件安装(clangd插件为C/C++提供补全、导航和检查等语法功能)
- 启动通用集成开发环境
@ -89,7 +89,7 @@
### 2.1.2 通过项目创建插件创建c/c++程序
插件商店点击筛选器插件-》点击Kylin-IDE插件分类-》点击项目创建-》点击安装项目管理插件Kylin Project Manager,插件安装后点击资源管理器视图进入项目操作区创建C/C++程序,创建具体操作详情见:[项目管理插件](项目管理.md)
- 插件商店点击筛选器插件-》点击Kylin-IDE插件分类-》点击项目创建-》点击安装项目管理插件Kylin Project Manager,插件安装后点击资源管理器视图进入项目操作区创建C/C++程序,创建具体操作详情见:[项目管理插件](项目管理.md)
![图5 项目创建插件创建程序](resources/c-c++/visix-new-project.gif)
## 2.2 编辑
@ -152,7 +152,7 @@
- 点击扩展-聚焦Kylin-clangd插件点击设置点击插件设置
- 跳转到设置页面在搜索设置中输入qt点击工作区在qt代码补全头文件设置中选择设置QT4/QT5头文件路径点击重启clangd服务如下图所示为QT代码补全头文件设置
![图9 QT头文件设置](resources/c-c++/qt.gif)
![图9 QT头文件设置](resources/c-c++/qt.gif)
# 3.编译与运行

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 85 KiB

View File

@ -1,19 +1,24 @@
# 远程开发插件安装使用说明
## 1、准备工作
- 提供一台客户机以及要远程的远程机,提供远程机的真实用户和密码
- 检查在客户机能够使用用户和密码通过ssh连接到远程机
- 检查“远程机”的sshd服务是否正常“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel”为yes
- 如果“AllowTcpForwarding”和“PermitTunnel”为no请修改配置并重启sshd服务
## 1、插件安装
- 从gitea中将远程开发插件下载到本地
## 2、插件安装
- 从gitea中将远程开发插件下载到客户机本地
- 将插件下载到本地然后点击插件管理器选择从VSIX安装
![1-1](resources/kylin-remote-dev/remote-install.gif "通过VSIX安装插件")
![2-1](resources/kylin-remote-dev/remote-install.gif "通过VSIX安装插件")
- 安装完成后,将在左侧活动栏中出现远程开发插件图标,点击图标进入远程资源管理器页面
- 远程开发环境服务端软件包下载:
- 根据要远程的开发环境架构从gitee中选择对应架构的软件包进行下载。[远程开发服务端软件包](https://gitee.com/mcy-kylin/kylin-ide-server/releases/)
- 将下载的软件包放在本地环境中安装远程开发插件的用户.cache目录下
- 根据要远程的远程机的架构从gitee中选择对应架构的软件包进行下载。[远程开发服务端软件包](https://gitee.com/mcy-kylin/kylin-ide-server/releases/)
- 将下载的软件包放在客户机本地环境中安装远程开发插件的用户.cache目录下
## 2、远程资源管理
## 3、远程资源管理
- 在“远程资源管理器”中提供了查看设置、新建连接、刷新等功能:
- 查看设置:提供配置文件查看功能,点击后将在编辑区打开配置文件。
@ -21,57 +26,59 @@
- 点击添加按钮,弹出输入框,根据提示输入远程环境用户名@ip (该用户名是远程服务端真实存在的用户)
- 在“远程资源管理器”中显示新增的连接
![2-1](resources/kylin-remote-dev/remote-addconnect.gif "连接添加")
![3-1](resources/kylin-remote-dev/remote-addconnect.gif "连接添加")
- 刷新:提供手动刷新功能,当手动修改配置后,点击刷新对“远程资源管理器”中的连接进行更新
## 3、连接管理
## 4、连接管理
- 新窗口打开:
- 点击连接右边的“新窗口打开”图标
- 在弹出输入框中,输入远程开发环境密码,将在新的窗口中打开远程开发环境(该密码为此连接在新建连接时输入的用户名对应的密码,用户名和密码是远程服务端真实存在的用户和登录密码)
![3-1](resources/kylin-remote-dev/remote-openwindow.gif "新窗口打开")
![4-1](resources/kylin-remote-dev/remote-openwindow.gif "新窗口打开")
- 右键菜单:将鼠标放置在连接上,点击鼠标右键,将弹出右键菜单;包括新窗口打开、浏览器打开、删除连接、重命名
![3-2](resources/kylin-remote-dev/remote-menu.gif "右键菜单")
![4-2](resources/kylin-remote-dev/remote-menu.gif "右键菜单")
- 新窗口打开效果同上步的新窗口打开图标
- 浏览器打开:点击“浏览器打开”,在输入狂中输入远程开发环境密码,将在浏览器中打开远程开发环境
![3-3](resources/kylin-remote-dev/remote-openweb.gif "浏览器打开")
![4-3](resources/kylin-remote-dev/remote-openweb.gif "浏览器打开")
- 删除连接:将删除当前连接
- 重命名连接名默认显示ip地址点击“重命名”可以对当前连接进行命名方便用户记忆。
## 4、项目管理、多语言开发、调试功能使用
## 5、项目管理、多语言开发、调试功能使用
- 通过远程开发插件打开远程开发环境后其使用方法和Kylin-IDE编辑器类似。
- 插件安装
- 打开远程开发环境后可通过窗口上方标题显示的ip来区分所连接的远程环境与本地环境。
- 远程开发环境插件的安装方法和Kylin-IDE相同
- 插件安装后在“LOCALHOST:PORT-已安装”中显示远程开发环境已安装的插件
![4-1](resources/kylin-remote-dev/remote-dev-install.gif "插件安装")
![5-1](resources/kylin-remote-dev/remote-dev-install.gif "插件安装")
- 项目管理
- 项目管理功能使用方法请参见[项目管理章节](%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86)
- 多语言开发
- 提供C、C++、Java、Python、Go、JavaScript语言的代码开发功能包括代码编辑、编译、调试、运行等功能具体使用条件和方法请参见[C-C++开发章节](./C-C%2B%2B%E5%BC%80%E5%8F%91.md)、[Java开发章节](./Java%E5%BC%80%E5%8F%91.md)、[Python开发章节](./Python%E5%BC%80%E5%8F%91.md)、[Go开发章节](./Go%E5%BC%80%E5%8F%91.md)、[JavaScript开发章节](./JavaScript%E5%BC%80%E5%8F%91.md)。
## 5、远程开发环境卸载
## 6、远程开发环境卸载
- 服务端卸载
- 删除远程服务端用户目录下.kylin-ide-server 目录
- 检查远程机“server-main”服务进程是否存在如果存在请杀死该进程或等进程自动退出
- 删除远程机用户目录下.kylin-ide-server 目录
- 客户端卸载
- 从Kylin-IDE中删除远程开发插件同时删除用户目录下.kylin-ide-remote目录
- 注意:卸载操作旨在彻底清除环境中远程开发相关数据,可以用于版本升级或重装等操作,无需在每次使用完后进行卸载操作
## 6、例子
## 7、例子
- 假如希望从A主机的“user1”用户远程到B主机“test”用户进行远程开发则A主机即为客户端B主机即为服务端
- 使用远程开发的准备工作:
- 登录A主机的“user”用户启动Kylin-IDE并安装将远程插件
- 根据B主机的架构类型下载对应的远程开发服务端软件包并将远程开发服务端软件包放在A主机的“user1”用户的.cache目录下
- 检查B主机的sshd服务是否正常“/etc/ssh/sshd_config”中 “AllowTcpForwarding” 为yes
- 检查B主机的sshd服务是否正常“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel ” 为yes
- 提供B主机的用户名“test”和密码“passwd”检查在A上是否能够使用用户名test通过ssh连接到B
- 新建连接
@ -79,7 +86,7 @@
- 新窗口打开
- 点击新窗口打开图标在输入框中输入test用户的密码该密码为B主机中test用户的ssh登录密码
- 服务端卸载
- 上步新窗口打开使用的是test用户则去B主机test用户下删除.kylin-ide-server目录
- 上步新窗口打开使用的是test用户则去B主机test用户下删除.kylin-ide-server目录并确保“server-main”服务进程退出
- 客户端卸载
- 卸载Kylin-IDE中的远程开发插件并删除A主机用户“user1”目录下的.kylin-ide-remote目录