diff --git a/README.md b/README.md index 128c064..bea8b68 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,73 @@ -# SuperIDE +# DevStar -#### 介绍 -Super IDE Client for VS Code +## User Quick Start -#### 软件架构 -软件架构说明 +进入home页面,home页面的功能都需要登录后才能使用。(不需要登录的功能:) +登录后,登录状态会长久保存,直到主动退出登录或者卸载插件。 -#### 安装教程 +### 创建新仓库/创建新项目 -1. xxxx -2. xxxx -3. xxxx +目前可供选择的字段 -#### 使用说明 +- name* 必填 +- default_branch +- description +- gitignores +- issue_labels +- license +- object_format_name +- private +- readme +- template +- trust_model -1. xxxx -2. xxxx -3. xxxx +### 打开项目 -#### 参与贡献 +打开项目是指在vscode上打开远程容器中创建好的项目。选择项目名称右侧对应的Open project,即可打开项目。 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +### 编译/调试 +容器环境提供了开发环境,安装好编译与调试所需要的工具链。 -#### 特技 +## Developer Quick Start -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +### 准备开发环境 + +1. git clone项目到本地,然后通过VSCode打开项目 + +2. 项目提供了devcontainer的开发配置,通过vscode打开本项目后,会提示“Folder contains a Dev Container configuration file. Reopen folder to develop in a container ([learn more](https://aka.ms/vscode-remote/docker)).”,此时点击“Reopen in Container”,自动进入vscode的devcontainer环境中。 + +3. 本项目的devcontainer预置了Node.js & Typescript的开发环境。在vscode的命令行工具执行`npm install`命令,下载项目所需依赖。 + +### 编译插件 + +1. 项目目录`.vscode/launch.json`中提供了编译与启动插件的配置。 +2. 按`F5`即可编译和测试插件。 + +### 打包&发布插件 + +1. 打包和发布插件均需要用到`@vscode/vsce`包,项目依赖中已包含。 +2. 打包插件 + 1. 方法一:通过Ctrl+Shift+P启动Command Palette,选择Tasks: Run Task,然后选择最下方的Show All Tasks...,最后选择npm: vscode:package。 + 2. 方法二:打开package.json文件,找到`scripts`字段,它上方有`Debug`按钮,点击之后会让你选择要执行的task,选择vscode:package。 +3. 发布插件 + 1. 发布之前需要先完成打包。 + 2. 发布插件需要publisher的Personal Access Token(token项目负责人)。(Token**有效时间**:1年) + 3. 发布方法 + 1. 方法一:步骤与打包插件的方法一基本一样,除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt,填上回车即可。 + 2. 方法二:步骤与打包插件的方法二基本一样,除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt,填上回车即可。 + +### 特殊:webview页面 + +目前插件的webview页面尚未嵌入插件,仍以index.html的方式独立存在。在容器中不能访问主机的http://localhost:8080/tmp/index.html页面,所以开发webview页面还需要在主机上进行。等后续将index.html的内容移植到插件中,即可在devcontainer中开发。 + +### 特殊:Git + +由于先在主机上clone下来项目,在devcontainer上再打开以后,git认为所有的文件都更改了。需要在`.git/config`添加如下的配置: + +```bash +[core] + - filemode = false + - autocrlf = true +``` \ No newline at end of file