docs: make Chinese README the default

2026-07-13 10:10:22 +00:00
parent ed4a7a98b9
commit 7bf2cb5581
1 changed files with 229 additions and 0 deletions
@@ -0,0 +1,229 @@
+<!-- WEHUB_ZH_README -->
+> [!NOTE]
+> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。  
+> [English](./README.en.md) · [原始项目](https://github.com/QuantConnect/Lean) · [上游 README](https://github.com/QuantConnect/Lean/blob/HEAD/readme.md)  
+> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/f3581da5-1983-4f6c-af5a-55c79b37913a">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/0f8022d5-952d-418c-9011-2644830137d2">
+  <img alt="lean-header" width="100%">
+</picture>
+<br />
+<br />
+
+[![Build Status](https://github.com/QuantConnect/Lean/workflows/Build%20%26%20Test%20Lean/badge.svg)](https://github.com/QuantConnect/Lean/actions?query=workflow%3A%22Build%20%26%20Test%20Lean%22) &nbsp;&nbsp;&nbsp; [![Regression Tests](https://github.com/QuantConnect/Lean/workflows/Regression%20Tests/badge.svg)](https://github.com/QuantConnect/Lean/actions?query=workflow%3A%22Regression%20Tests%22) &nbsp;&nbsp;&nbsp; [![LEAN Forum](https://img.shields.io/badge/debug-LEAN%20Forum-53c82b.svg)](https://www.quantconnect.com/forum/discussions/1/lean) &nbsp;&nbsp;&nbsp; [![Discord Chat](https://img.shields.io/badge/chat-Discord-53c82b.svg)](https://www.quantconnect.com/discord)
+
+
+[Lean Home][1] | [Documentation][2] | [Download Zip][3] | [Docker Hub][8] | [Nuget][9]
+
+#
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/09d7707d-619d-48e2-b6d9-ef2d2d61144b">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/aab2422c-f480-421d-9ad2-5a355843d82a">
+  <img alt="features-header" width="100%">
+</picture>
+
+LEAN 是一款事件驱动（event-driven）、专业级（professional-caliber）的算法交易平台（algorithmic trading platform），以优雅的工程实现和对深度量化（quant）概念建模的热情而构建。开箱即用地支持另类数据（alternative data）和实盘交易（live-trading）。
+<br/>
+<br/>
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/d0ca17eb-307f-4155-b989-9afe502845b9">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/9135fa86-c3e3-48e6-bbf9-de97f17afb52">
+  <img alt="feature-list" width="100%">
+</picture>
+
+<br/>
+<br/>
+
+#
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/f486e040-e350-4c9b-98c5-7b3902c0b7d8">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/d28fd3d4-dad8-4828-94a9-676ddb360bdd">
+  <img alt="modular-header" width="100%">
+</picture>
+LEAN 采用模块化设计，每个组件均可插拔且可定制。它内置了所有主要插件接入点的模型。
+<br/>
+<br/>
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/7989d185-45cd-4a40-acef-6ff61d9d82f6">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/5f9cc976-a715-495a-9977-87961509d2e0">
+  <img alt="modular-architecture" width="100%">
+</picture>
+
+#
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/9b7b7abf-b0f5-41a3-8a1b-a9400738b27a">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/1bb1dd23-dbc7-4a96-b556-edbae84012b5">
+  <img alt="cli-header" width="100%">
+</picture>
+
+<img width="100%" alt="lean-animation" src="https://github.com/user-attachments/assets/09a32ba9-99ee-4fa9-9b33-d98dbf5d291f">
+
+QuantConnect Lean CLI 是一款用于与 Lean 算法交易引擎交互的命令行界面（command-line interface）工具；Lean 是一个开源平台，可在多个金融市场中对算法进行回测（backtesting）和实盘交易（live trading）。它允许开发者管理项目、运行回测、部署实盘算法，并直接在终端中执行与算法交易相关的各种其他任务。该 CLI 通过自动化任务简化工作流程，实现与云服务的无缝集成，并促进与 QuantConnect 社区的协作。它面向需要强大而灵活的工具来简化交易策略的量化开发者。请观看[说明视频](https://www.youtube.com/watch?v=QJibe1XpP-U&list=PLD7-B3LE6mz61Hojce6gKshv5-7Qo4y0r)以了解更多。
+
+### 安装
+
+```
+pip install lean
+```
+
+
+### 命令
+
+创建包含入门代码的新项目
+
+```
+lean project-create
+```
+
+使用 Docker 运行本地 Jupyter Lab 环境
+
+```
+lean research
+```
+
+使用 Docker 在本地回测项目
+
+```
+lean backtest
+```
+
+使用 Docker 在本地优化项目
+
+```
+lean optimize
+```
+
+使用 Docker 在本地启动项目的实盘交易
+
+```
+lean live
+```
+
+下载 [LEAN CLI 速查表](https://cdn.quantconnect.com/i/tu/cli-cheat-sheet.pdf)以查看完整命令列表。
+
+#
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/85b548f8-9fd1-47f1-9b10-d73b3cfc6b23">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/b6866983-adac-4461-ac2f-8642a72ef2a5">
+  <img alt="modular-architecture" width="100%">
+</picture>
+<br>
+
+![diagram](https://github.com/user-attachments/assets/f482fae4-5908-4d95-a427-4b1d685c355c)
+
+#
+
+<picture >
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/7b230a0d-6bf2-45bb-872e-c0faf4f1471e">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/23b59138-aab5-43c3-91b0-20eff46ab21a">
+  <img alt="modular-architecture" width="100%">
+</picture>
+
+
+本节将介绍如何在本地安装 Lean，以便在你的环境中使用。**对于大多数用户，我们强烈建议使用预构建且可在所有平台上运行的 LEAN CLI。** 有关在本地 IDE 中使用 Lean 的详细指南，请参阅以下 readme 文件。
+<br/>
+
+* [VS Code](.vscode/readme.md)
+* [VS](.vs/readme.md)
+  
+要在本地安装，请下载包含[最新 master](https://github.com/QuantConnect/Lean/archive/master.zip)的 zip 文件，并解压到你喜欢的位置。或者，安装 [Git](https://git-scm.com/downloads)并克隆该仓库：
+
+```
+git clone https://github.com/QuantConnect/Lean.git
+cd Lean
+```
+
+### macOS 
+
+注意：Visual Studio for Mac [已停止维护](https://learn.microsoft.com/en-gb/visualstudio/releases/2022/what-happened-to-vs-for-mac),请改用 Visual Studio Code
+
+- 安装 [Visual Studio Code for Mac](https://code.visualstudio.com/download)
+- 安装 [C# Dev Kit extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
+- 安装 [dotnet 9 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/9.0):
+- 要构建解决方案，可以：
+  - 在 Panel 任务下拉菜单中选择 **Run Task** > **build**，或
+  - 在命令行中运行
+    ```
+    dotnet build
+    ```
+- 要运行解决方案，可以：
+  - 从 Activity Bar 选择 **Run and Debug**，然后点击 **Launch**，或
+  - 按 F5，或
+  - 在命令行中运行
+    ```
+    cd Launcher/bin/Debug
+    dotnet QuantConnect.Lean.Launcher.dll
+    ```
+
+### Linux (Debian, Ubuntu)
+
+- 安装 [dotnet 9](https://docs.microsoft.com/en-us/dotnet/core/install/linux):
+- 编译 Lean Solution：
+```
+dotnet build QuantConnect.Lean.sln
+```
+- 运行 Lean：
+```
+cd Launcher/bin/Debug
+dotnet QuantConnect.Lean.Launcher.dll
+```
+
+### Windows
+
+- 安装 [Visual Studio](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)
+- 在 Visual Studio 中打开 `QuantConnect.Lean.sln`
+- 通过点击 Build Menu -> Build Solution 构建解决方案（这应会触发 NuGet 包还原）
+- 按 `F5` 运行
+
+### Python Support
+
+有关 Python 安装过程的完整说明，请参阅 [Algorithm.Python](https://github.com/QuantConnect/Lean/tree/master/Algorithm.Python#quantconnect-python-algorithm-project)项目。
+
+### Local-Cloud Hybrid Development. 
+
+可在你喜欢的开发环境中无缝进行本地开发，并获得完整的自动补全和调试支持，从而快速轻松地定位策略中的问题。更多信息请参阅 [CLI Home](https://www.lean.io/cli)。
+
+## 问题与功能请求 ##
+
+请将 bug 和功能请求作为 issue 提交到 [Lean Repository][5]。提交 issue 前，请先阅读相关说明，确保不会重复提交。
+
+## 邮件列表 ##
+
+本项目的邮件列表可在 [LEAN Forum][6] 找到。请在此就安装与配置相关问题寻求帮助。
+
+## 贡献者与 Pull Request ##
+
+我们热烈欢迎贡献，但请你先阅读现有代码，了解其格式与注释风格，并确保你的贡献与现有风格一致。所有代码提交必须附带相应测试。请参阅[贡献者指南][7]。所有被接受的 pull request 将获得 QuantConnect 上的 $50 云额度。当你的 pull request 被合并后，请发送邮件至 support@quantconnect.com 并附上 PR 链接，以领取免费实盘交易。QC <3 Open Source。
+
+衷心感谢所有贡献者！
+
+<br/>
+
+<a href="https://github.com/QuantConnect/Lean/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=QuantConnect/Lean" />
+</a>
+
+## 致谢 ##
+
+QuantConnect 的开源离不开 Pioneers 的支持。Pioneers 组成了 QuantConnect 的核心 100 名早期订阅用户，他们的支持使我们得以将该项目以开源形式发布。
+
+Ryan H, Pravin B, Jimmie B, Nick C, Sam C, Mattias S, Michael H, Mark M, Madhan, Paul R, Nik M, Scott Y, BinaryExecutor.com, Tadas T, Matt B, Binumon P, Zyron, Mike O, TC, Luigi, Lester Z, Andreas H, Eugene K, Hugo P, Robert N, Christofer O, Ramesh L, Nicholas S, Jonathan E, Marc R, Raghav N, Marcus, Hakan D, Sergey M, Peter McE, Jim M, INTJCapital.com, Richard E, Dominik, John L, H. Orlandella, Stephen L, Risto K, E.Subasi, Peter W, Hui Z, Ross F, Archibald112, MooMooForex.com, Jae S, Eric S, Marco D, Jerome B, James B. Crocker, David Lypka, Edward T, Charlie Guse, Thomas D, Jordan I, Mark S, Bengt K, Marc D, Al C, Jan W, Ero C, Eranmn, Mitchell S, Helmuth V, Michael M, Jeremy P, PVS78, Ross D, Sergey K, John Grover, Fahiz Y, George L.Z., Craig E, Sean S, Brad G, Dennis H, Camila C, Egor U, David T, Cameron W, Napoleon Hernandez, Keeshen A, Daniel E, Daniel H, M.Patterson, Asen K, Virgil J, Balazs Trader, Stan L, Con L, Will D, Scott K, Barry K, Pawel D, S Ray, Richard C, Peter L, Thomas L., Wang H, Oliver Lee, Christian L..
+
+
+  [1]: https://www.lean.io/ "Lean 开源主页"
+  [2]: https://www.lean.io/docs/ "Lean 文档"
+  [3]: https://github.com/QuantConnect/Lean/archive/master.zip
+  [4]: https://www.quantconnect.com "QuantConnect"
+  [5]: https://github.com/QuantConnect/Lean/issues
+  [6]: https://www.quantconnect.com/forum/discussions/1/lean
+  [7]: https://github.com/QuantConnect/Lean/blob/master/CONTRIBUTING.md
+  [8]: https://hub.docker.com/orgs/quantconnect/repositories
+  [9]: https://www.nuget.org/profiles/jaredbroad