# 开发 chsrc ## 依赖与开发环境 请安装好： 1. `GCC` 或 `Clang` 2. [just] 或 `make` 3. `curl` **我推荐你使用 VS Code 开发，你可以在一分钟内成功编译、运行和 Debug `chsrc`** 1. `Ctrl-Shift-B` 直接构建 2. `F5` 直接开始 Debug
## 获取代码 ```bash # 请务必使用 dev 分支开发 $ git clone https://gitee.com/RubyMetric/chsrc.git -b dev ``` 关于分支的说明，可参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md)
## `make` 用户 ### 编译运行 ```bash make (b) # 在Windows上默认使用 cc 编译，在macOS上默认使用 clang 编译，在其他系统上默认使用 cc 编译 make CC=clang # 使用 clang 编译 make CC=gcc # 使用 gcc 编译 # 编译出 debug 版本: chsrc-debug just bd # 编译出 release 版本: chsrc-release just br ``` ```bash # 重新编译出 ./chsrc-debug，并启动 GDB 调试 (在macOS上启动 LLDB 调试) $ make debug # 重新编译出 ./chsrc-debug，并启动 LLDB 调试 $ make debug DEBUGGER=lldb ```
### 测试 ```bash make test-xy # 测试 xy.h make test-fw # 测试 framework make test # 测试上述两个 make test-cli # 测试命令 make clean ```
## `just` 用户 如果你使用 `just`，可以在 VS Code 中获得更好的体验 ### 编译运行 ```bash just (b) # 在Windows上默认使用 gcc 编译，在macOS上默认使用 clang 编译，在其他系统上默认使用 cc 编译 just CC=clang # 使用 clang 编译 just CC=gcc # 使用 gcc 编译 # 编译出 debug 版本: chsrc-debug just bd # 编译出 release 版本: chsrc-release just br ``` ```bash # 重新编译出 ./chsrc-debug，并启动 GDB 调试 (在macOS上启动 LLDB 调试) $ just debug # 重新编译出 ./chsrc-debug，并启动 LLDB 调试 $ just DEBUGGER=lldb debug ```
### 测试 ```bash just test-xy # 测试 xy.h just test-fw # 测试 framework just test # 测试上述两个 just test-cli # 测试命令 just clean ```
## 提交 PR 关于分支的说明以及如何提交代码，请参考 [./03-CONTRIBUTING.md](./03-CONTRIBUTING.md)
[just]: https://github.com/casey/just