-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16 from whats2000/Update/Update-README
Add: Add more language of the README
- Loading branch information
Showing
3 changed files
with
340 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# CodeBRT | ||
|
||
[简体中文](README_zh-CN.md) | [繁體中文](README_zh-TW.md) | ||
|
||
## Overview | ||
|
||
**Version**: 0.4.4 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,169 @@ | ||
# CodeBRT | ||
|
||
[English](README.md) | [繁體中文](README_zh-TW.md) | ||
|
||
## 总览 | ||
|
||
**版本**:0.4.4 | ||
|
||
**状态**:_开发中_ | ||
⚠️ 此项目目前处于测试阶段。某些功能仍在开发中,您可能会遇到错误或未完成的功能。 | ||
|
||
**CodeBRT** 是一个由人工智能驱动的助手,旨在帮助用户完成代码相关的工作,从编写和分析代码到管理调度任务。该项目是免费的、开源的,并且对所有人开放。 | ||
|
||
### 主要功能 | ||
|
||
- **代码对话聊天**:与AI交互以讨论和理解代码。 | ||
- **代码调度任务**:管理和自动化代码任务。 | ||
- **代码补全**:获取代码建议和补全。 | ||
- **代码分析**:分析代码以改进、排除错误或优化。 | ||
- **代码格式化**:自动格式化代码以遵守最佳实践。 | ||
- **语音助理**:通过语音指令和响应进行无需使用手的交互。 | ||
- **图像分析**:分析和理解与代码相关的图像等。 | ||
|
||
该项目利用 **VSCode 扩展 API** 以及各种 **语言模型 API**。 | ||
|
||
## 目录 | ||
|
||
- [总览](#总览) | ||
- [安装](#安装) | ||
- [使用](#使用) | ||
- [路线图](#路线图) | ||
- [贡献](#贡献) | ||
- [建议或错误](#建议或错误) | ||
- [参考资料](#参考资料) | ||
|
||
## 安装 | ||
|
||
要安装和开始使用 CodeBRT,请遵循以下步骤: | ||
|
||
- 使用 **VSCode 扩展**: | ||
1. 从[市场](https://marketplace.visualstudio.com/items?itemName=whats2000.code-brt)下载最新版本。 | ||
2. 在 Visual Studio Code 中安装扩展。 | ||
|
||
- 进行**本地开发**: | ||
1. 将仓库克隆到本地机器。 | ||
```shell | ||
git clone https://github.com/whats2000/CodeBRT.git | ||
``` | ||
2. 对于主要扩展: | ||
- 在 VSCode 中打开 `VSCodeExtension/code-brt` 文件夹。 | ||
```shell | ||
cd VSCodeExtension/code-brt | ||
``` | ||
- 在终端中执行 `npm install` 安装依赖项。 | ||
```shell | ||
npm install | ||
``` | ||
3. 在 VSCode 中运行扩展。 | ||
- 在 VSCode 中打开 `VSCodeExtension/code-brt` 文件夹。 | ||
- 在 `运行和调试` 面板中运行扩展。 | ||
|
||
**注意:** 文档仍在建设中,功能可能尚未完全记录。 | ||
|
||
## 使用 | ||
|
||
安装后,可以在 Visual Studio Code 中访问 CodeBRT。主要功能包括: | ||
|
||
- **与 AI 聊天**:使用聊天面板与 AI 进行代码相关的对话。 | ||
- **语音指令**:通过发出语音指令启动语音功能。 | ||
|
||
关于快速入门指南,请参考文档的[快速入门](https://whats2000.github.io/CodeBRT/docs/introduction)部分。 | ||
|
||
此外,还提供了外部插件以扩展项目的功能。在[此处](https://github.com/whats2000/CodeBRT/tree/main/ExternalPlugIn)探索可用的插件。 | ||
|
||
## 路线图 | ||
|
||
以下是 CodeBRT 即将推出的功能和改进概述: | ||
|
||
### 版本 0.1 | ||
|
||
- [x] 初始项目设置 | ||
- [x] VSCode API 集成 | ||
- [x] 语言模型 API 集成 | ||
- [x] 基本代码对话聊天 | ||
|
||
### 版本 0.2 | ||
|
||
- [x] 历史记录自定义(标记和排序) | ||
- [x] 自定义系统指令 | ||
- [x] 完整的语音输入和输出功能 | ||
- [x] 开源 GPT-SoVits 文本转语音集成 | ||
|
||
### 版本 0.3(正在进行中) | ||
|
||
- [x] 优化历史记录渲染 | ||
- [x] Redux 用于更好的状态管理 | ||
- [ ] 编辑器内聊天进行代码生成 | ||
- [ ] 使用热键手动代码补全 | ||
- [x] 触发代码补全 | ||
- [ ] 上下文检索 | ||
- [x] 自动代码补全 | ||
- [ ] 代码集成器以组合代码片段 <- **正在进行** | ||
|
||
### 版本 0.4(正在进行中) | ||
|
||
- [ ] 工具调用功能 | ||
- [x] 网络搜索 | ||
- [x] URL 获取 | ||
- [x] PDF 提取 | ||
- [x] 读取文件 | ||
- [x] 写入文件 | ||
- [x] 搜索文件 | ||
- [x] 列出文件使用上下文 | ||
- [x] 执行代码 | ||
- [x] 网站检查器 | ||
- [x] 列出代码定义 | ||
- [ ] 图像生成 | ||
- [ ] 代码解释器 | ||
- [x] 显示代码补全后的文件差异 | ||
- [ ] 任务调度 | ||
- [ ] 自动任务调度和完成 | ||
- [ ] 自动调试 | ||
- [ ] 本地高级数据分析 | ||
- [ ] 繁体中文/简体中文本地化支持 | ||
|
||
### 版本 1.0(稳定版本) | ||
|
||
- [ ] 用于代码生成的架构模式 | ||
- [ ] 智能本地化支持(多语言 `.json` 生成器) | ||
- [ ] 代码文档配对生成 | ||
- [ ] 代码实用程序测试生成 | ||
- [ ] 代码风格分析 | ||
- [ ] 改进早期版本的功能 | ||
|
||
### 后续版本 | ||
该项目将持续演进,增加新功能和改进。敬请关注更多更新! | ||
|
||
## 贡献 | ||
|
||
我们欢迎贡献!无论您是修复错误、新增功能还是改进文档,您的帮助都是值得感谢的。 | ||
|
||
要贡献: | ||
|
||
1. 在 GitHub 上分叉仓库。 | ||
2. 创建一个新的功能分支。 | ||
3. 进行您的更改并提交拉取请求。 | ||
|
||
更多信息,请访问 [GitHub 仓库](https://github.com/whats2000/CodeBRT)。 | ||
|
||
## 建议或错误 | ||
|
||
如果您有任何建议、功能请求或错误报告,请在 GitHub 仓库的[问题部分](https://github.com/whats2000/CodeBRT/issues)提交。我们重视您的反馈,并致力于根据社区意见改进项目。 | ||
|
||
## 参考资料 | ||
|
||
CodeBRT 建立在各种开源工具和框架之上。特别感谢以下: | ||
|
||
- [VSCode 扩展的起始框架](https://github.com/sfc-gh-tkojima/vscode-react-webviews) by [sfc-gh-tkojima](https://github.com/sfc-gh-tkojima) | ||
- [Continue 项目,用于 LLM 响应的处理](https://github.com/continuedev/continue/) by continuedev 团队(Apache 许可 2.0) | ||
- [Cline 项目,用于基于代理的框架](https://github.com/clinebot/cline) by [saoudrizwan](https://github.com/saoudrizwan/)(Apache 许可 2.0) | ||
|
||
- 来自 [SVG Repo](https://www.svgrepo.com/) 的图标和徽标: | ||
- [Vscode2 打开的 SVG 矢量](https://www.svgrepo.com/svg/373400/vscode2-opened)(MIT 许可) | ||
- [缩进 SVG 矢量](https://www.svgrepo.com/svg/532181/indent)(CC 署名授权) | ||
- [停止圆形 SVG 矢量](https://www.svgrepo.com/svg/361332/stop-circle)(MIT 许可) | ||
|
||
--- | ||
|
||
**许可**:[GNU 通用公共许可](https://github.com/whats2000/CodeBRT/blob/main/LICENSE.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,169 @@ | ||
# CodeBRT | ||
|
||
[English](README.md) | [简体中文](README_zh-CN.md) | ||
|
||
## 總覽 | ||
|
||
**版本**:0.4.4 | ||
|
||
**狀態**:_開發中_ | ||
⚠️ 此專案目前處於測試階段。某些功能仍在開發中,您可能會遇到錯誤或未完成的功能。 | ||
|
||
**CodeBRT** 是一個由人工智能驅動的助手,旨在幫助使用者完成程式碼相關的工作,從編寫和分析程式碼到管理排程任務。該專案是免費的、開源的,並且對所有人開放。 | ||
|
||
### 主要功能 | ||
|
||
- **程式碼對話聊天**:與AI互動以討論和理解程式碼。 | ||
- **程式碼排程任務**:管理和自動化程式碼任務。 | ||
- **程式碼補全**:獲取程式碼建議和補全。 | ||
- **程式碼分析**:分析程式碼以改進、排除錯誤或優化。 | ||
- **程式碼格式化**:自動格式化程式碼以遵守最佳實踐。 | ||
- **語音助理**:通過語音指令和回應進行無需使用手的交互。 | ||
- **圖像分析**:分析和理解與程式碼相關的圖像等。 | ||
|
||
該專案利用 **VSCode 擴展 API** 以及各種 **語言模型 API**。 | ||
|
||
## 目錄 | ||
|
||
- [總覽](#總覽) | ||
- [安裝](#安裝) | ||
- [使用](#使用) | ||
- [路線圖](#路線圖) | ||
- [貢獻](#貢獻) | ||
- [建議或錯誤](#建議或錯誤) | ||
- [參考資料](#參考資料) | ||
|
||
## 安裝 | ||
|
||
要安裝和開始使用 CodeBRT,請遵循以下步驟: | ||
|
||
- 使用 **VSCode 擴展**: | ||
1. 從[市集](https://marketplace.visualstudio.com/items?itemName=whats2000.code-brt)下載最新版本。 | ||
2. 在 Visual Studio Code 中安裝擴展。 | ||
|
||
- 進行**本地開發**: | ||
1. 將儲存庫克隆到本地機器。 | ||
```shell | ||
git clone https://github.com/whats2000/CodeBRT.git | ||
``` | ||
2. 對於主要擴展: | ||
- 在 VSCode 中打開 `VSCodeExtension/code-brt` 資料夾。 | ||
```shell | ||
cd VSCodeExtension/code-brt | ||
``` | ||
- 在終端機中執行 `npm install` 安裝依賴項。 | ||
```shell | ||
npm install | ||
``` | ||
3. 在 VSCode 中運行擴展。 | ||
- 在 VSCode 中打開 `VSCodeExtension/code-brt` 資料夾。 | ||
- 在 `執行和除錯` 面板中運行擴展。 | ||
|
||
**注意:** 文檔仍在建設中,功能可能尚未完全記錄。 | ||
|
||
## 使用 | ||
|
||
安裝後,可以在 Visual Studio Code 中訪問 CodeBRT。主要功能包括: | ||
|
||
- **與 AI 聊天**:使用聊天面板與 AI 進行程式碼相關的對話。 | ||
- **語音指令**:通過發出語音指令啟動語音功能。 | ||
|
||
關於快速入門指南,請參考文檔的[快速入門](https://whats2000.github.io/CodeBRT/docs/introduction)部分。 | ||
|
||
此外,還提供了外部外掛程式以擴展專案的功能。在[此處](https://github.com/whats2000/CodeBRT/tree/main/ExternalPlugIn)探索可用的外掛程式。 | ||
|
||
## 路線圖 | ||
|
||
以下是 CodeBRT 即將推出的功能和改進概述: | ||
|
||
### 版本 0.1 | ||
|
||
- [x] 初始專案設置 | ||
- [x] VSCode API 整合 | ||
- [x] 語言模型 API 整合 | ||
- [x] 基本程式碼對話聊天 | ||
|
||
### 版本 0.2 | ||
|
||
- [x] 歷史記錄自訂(標記和排序) | ||
- [x] 自訂系統指令 | ||
- [x] 完整的語音輸入和輸出功能 | ||
- [x] 開源 GPT-SoVits 文字轉語音整合 | ||
|
||
### 版本 0.3(正在進行中) | ||
|
||
- [x] 優化歷史記錄渲染 | ||
- [x] Redux 用於更好的狀態管理 | ||
- [ ] 編輯器內聊天進行程式碼生成 | ||
- [ ] 使用熱鍵手動程式碼補全 | ||
- [x] 觸發程式碼補全 | ||
- [ ] 上下文檢索 | ||
- [x] 自動程式碼補全 | ||
- [ ] 程式碼整合器以組合程式碼片段 <- **正在進行** | ||
|
||
### 版本 0.4(正在進行中) | ||
|
||
- [ ] 工具呼叫功能 | ||
- [x] 網路搜尋 | ||
- [x] URL 獲取 | ||
- [x] PDF 提取 | ||
- [x] 讀取檔案 | ||
- [x] 寫入檔案 | ||
- [x] 搜尋檔案 | ||
- [x] 列出檔案使用上下文 | ||
- [x] 執行程式碼 | ||
- [x] 網站檢查器 | ||
- [x] 列出程式碼定義 | ||
- [ ] 圖像生成 | ||
- [ ] 程式碼解釋器 | ||
- [x] 顯示程式碼補全後的檔案差異 | ||
- [ ] 任務排程 | ||
- [ ] 自動任務排程和完成 | ||
- [ ] 自動除錯 | ||
- [ ] 本地高級數據分析 | ||
- [ ] 繁體中文/簡體中文本地化支持 | ||
|
||
### 版本 1.0(穩定版本) | ||
|
||
- [ ] 用於程式碼生成的架構模式 | ||
- [ ] 智能本地化支持(多語言 `.json` 生成器) | ||
- [ ] 程式碼文檔配對生成 | ||
- [ ] 程式碼實用程式測試生成 | ||
- [ ] 程式碼風格分析 | ||
- [ ] 改進早期版本的功能 | ||
|
||
### 後續版本 | ||
該專案將持續演進,增加新功能和改進。敬請關注更多更新! | ||
|
||
## 貢獻 | ||
|
||
我們歡迎貢獻!無論您是修復錯誤、新增功能還是改進文檔,您的幫助都是值得感謝的。 | ||
|
||
要貢獻: | ||
|
||
1. 在 GitHub 上分叉儲存庫。 | ||
2. 創建一個新的功能分支。 | ||
3. 進行您的更改並提交拉取請求。 | ||
|
||
更多資訊,請訪問 [GitHub 儲存庫](https://github.com/whats2000/CodeBRT)。 | ||
|
||
## 建議或錯誤 | ||
|
||
如果您有任何建議、功能請求或錯誤報告,請在 GitHub 儲存庫的[問題部分](https://github.com/whats2000/CodeBRT/issues)提交。我們重視您的反饋,並致力於根據社群意見改進專案。 | ||
|
||
## 參考資料 | ||
|
||
CodeBRT 建立在各種開源工具和框架之上。特別感謝以下: | ||
|
||
- [VSCode 擴展的起始框架](https://github.com/sfc-gh-tkojima/vscode-react-webviews) by [sfc-gh-tkojima](https://github.com/sfc-gh-tkojima) | ||
- [Continue 專案,用於 LLM 回應的處理](https://github.com/continuedev/continue/) by continuedev 團隊(Apache 授權 2.0) | ||
- [Cline 專案,用於基於代理的框架](https://github.com/clinebot/cline) by [saoudrizwan](https://github.com/saoudrizwan/)(Apache 授權 2.0) | ||
|
||
- 來自 [SVG Repo](https://www.svgrepo.com/) 的圖示和標誌: | ||
- [Vscode2 打開的 SVG 向量](https://www.svgrepo.com/svg/373400/vscode2-opened)(MIT 授權) | ||
- [縮排 SVG 向量](https://www.svgrepo.com/svg/532181/indent)(CC 姓名標示授權) | ||
- [停止圓形 SVG 向量](https://www.svgrepo.com/svg/361332/stop-circle)(MIT 授權) | ||
|
||
--- | ||
|
||
**授權**:[GNU 通用公共授權](https://github.com/whats2000/CodeBRT/blob/main/LICENSE.md) |