README.cn

基于开源的VS Code

这里是开发说明，使用相关信息在：

• 论坛
• Issue List
• Wiki

开发、发布前的准备

1. 安装系统级依赖：
   1. Windows:
      • 仅支持Windows 10 64位，且安装了较新的更新。
      • Git，安装时选择 “Run Git from the Windows Command Prompt”
      • 推荐顺便安装 GitHub for windows
   2. Linux:
      • 仅支持比较新的发行版（比如最新版 Ubuntu、Fedora、Arch 等，不支持 CentOS、老的 Ubuntu 等）
      • 安装以下软件包（dnf install -y、apt install -y……）

      bash wget curl tar xz findutils git
      make gcc-c++ libstdc++ gtk2 libXtst libXScrnSaver GConf2 alsa-lib
      libsecret-devel libX11-devel libxkbfile-devel
      wqy-zenhei-fonts wqy-unibit-fonts wqy-bitmap-fonts # locale font
      

   3. Mac:
      • 先确认系统版本较新
      • 如果没有 Homebrew 需要先安装
      • 使用 Homebrew 安装系统级依赖

      brew install xz coreutils p7zip findutils gnu-tar gnu-sed gawk gnutls gnu-indent gnu-getopt wget md5sha1sum gnutls --with-default-names

      • 在 ~/.bashrc 中添加一行：

      export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"

2. 启动一个终端（如果是 Windows，则启动 powershell，而不是 cmd）
3. 下载源码，cd 进去 git clone git@github.com:kendryte/kendryte-ide.git && cd kendryte-ide
4. 加载所需的环境： 👈 之后每次从这步开始

   1. 下载 kendryte-ide-shell 客户端项目并进入

      git clone https://github.com/GongT/kendryte-ide-shell && cd kendryte-ide-shell

      kendryte-ide 和 kendryte-ide-shell 目录关系如下

      • Dir
        • kendryte-ide
        • kendryte-ide-shell

   2. 安装 kendryte-ide-shell 项目所需依赖

      yarn install

   3. 配置 S3 密钥

      该步骤请联系管理员GongT

   4. 在 kendryte-ide-shell 环境中打开 kendryte-ide 项目

      1. windows：.\scripts\start.ps1 如果提示禁止运行，参考 powershell 运行策略
      2. Linux & Mac: ./scripts/start.sh

   5. 在 kendryte-ide-shell 中执行 install-dependency 以安装 kendryte-ide 的依赖

😘 每个命令行窗口都需要运行 start.ps1 或者 start.sh。
😘 但首次运行成功（或失败）前，不要同时运行另一个，容易产生冲突。

通过源码运行

1. 系统级 bash 入口统一从 kendryte-ide-shell 进入，在执行 ./scripts/start.sh 或 ./scripts/start.ps1 后 kendryte-shell 会自动进入 kendryte-ide 目录
2. 首次需要开启至少3个终端窗口
3. 其中一个终端窗口在 kendryte-shell 中执行 start-watch
4. 等待约1分钟，显示类似“compilation success”的消息后，继续下一步
5. 新建系统级 bash 窗口，进入 kendryte-ide-shell 项目，执行 yarn watch
6. 上一个 bash 窗口出现 Starting 'scripts:watch:ts' 字样后新建系统级 bash 窗口，进入 kendryte-ide-shell 项目，执行 yarn start，即可启动项目

发布新版本

1. 执行 build
2. 等待半小时左右，生成的文件保存在 .release/release-files
3. 如果中途出错，日志在 .release/logs/build.log

说明：

• 除了下面说明外，所有脚本都不需要管理员权限。程序中包含大量第三方代码，使用root或管理员权限导致问题概不负责。
• 调试需要6GB左右（磁盘空间）
• 生成需要4GB左右
• 调试和生成使用的文件夹不同，同时又要调试又要生成，则需要10GB

windows 上的特别说明：

• 首次运行 start.ps1 的时候可能会请求管理员权限，以安装编译器（msbuild 等）
• 不要用 yarn add，直接修改 package.json 然后再次执行 install-dependency

已知问题：

• windows上首次安装脚本不可靠。如果尝试几次都不行，需要手动安装 MSBuild 2015
• Linux 上release-build可能失败，到.release/kendryte-ide-xxxxx中手动运行yarn install成功后再试

License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License.