senset/vnpy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Mod] update README.md

Browse Source
This commit is contained in:
vn.py 2019-09-17 23:58:16 +08:00
parent 15bdeea400
commit 6279ab4ddf
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -20,9 +20,9 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1
<img src ="https://vnpy.oss-cn-shanghai.aliyuncs.com/vnpy_qr.jpg"/>
</p>
在使用vn.py进行二次开发（策略、模块等）的过程中有任何疑问，请查看[**vn.py项目文档**]（https://www.vnpy.com/docs/cn/index.html），如果无法解决请前往[**官方社区论坛**]（https://www.vnpy.com/forum/）的【提问求助】板块寻求帮助，也欢迎在【经验分享】板块分享你的使用心得！
在使用vn.py进行二次开发（策略、模块等）的过程中有任何疑问，请查看[**vn.py项目文档**](https://www.vnpy.com/docs/cn/index.html)，如果无法解决请前往[**官方社区论坛**](https://www.vnpy.com/forum/)的【提问求助】板块寻求帮助，也欢迎在【经验分享】板块分享你的使用心得！
2.0版本基于Python 3.7全新重构开发，如需Python 2上的版本请点击：[长期支持版本v1.9.2 LTS]（https://github.com/vnpy/vnpy/tree/v1.9.2-LTS）。
2.0版本基于Python 3.7全新重构开发，如需Python 2上的版本请点击：[长期支持版本v1.9.2 LTS](https://github.com/vnpy/vnpy/tree/v1.9.2-LTS)。
## 功能特点
@ -116,19 +116,19 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1
7. Python高性能K线图表（vnpy.chart），支持大数据量图表显示以及实时数据更新功能。
8. [社区论坛]（http://www.vnpy.com）和[知乎专栏]（http://zhuanlan.zhihu.com/vn-py），内容包括vn.py项目的开发教程和Python在量化交易领域的应用研究等内容。
8. [社区论坛](http://www.vnpy.com)和[知乎专栏](http://zhuanlan.zhihu.com/vn-py)，内容包括vn.py项目的开发教程和Python在量化交易领域的应用研究等内容。
9. 官方交流群262656087（QQ），管理严格（定期清除长期潜水的成员），入群费将捐赠给vn.py社区基金。
## 环境准备
* 推荐使用vn.py团队为量化交易专门打造的Python发行版[VNStudio-2.0.6]（https://download.vnpy.com/vnstudio-2.0.6.exe），内置了最新版的vn.py框架以及VN Station量化管理平台，无需手动安装
* 推荐使用vn.py团队为量化交易专门打造的Python发行版[VNStudio-2.0.6](https://download.vnpy.com/vnstudio-2.0.6.exe)，内置了最新版的vn.py框架以及VN Station量化管理平台，无需手动安装
* 支持的系统版本：Windows 7以上/Windows Server 2008以上/Ubuntu 18.04 LTS
* 支持的Python版本：Python 3.7 64位（**注意必须是Python 3.7 64位版本**）
## 安装步骤
在[这里]（https://github.com/vnpy/vnpy/releases）下载最新版本，解压后运行以下命令安装：
在[这里](https://github.com/vnpy/vnpy/releases)下载最新版本，解压后运行以下命令安装：
**Windows**
@ -141,9 +141,9 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1
## 使用指南
1. 在[SimNow]（http://www.simnow.com.cn/）注册CTP仿真账号，并在[该页面]（http://www.simnow.com.cn/product.action）获取经纪商代码以及交易行情服务器地址。
1. 在[SimNow](http://www.simnow.com.cn/)注册CTP仿真账号，并在[该页面](http://www.simnow.com.cn/product.action)获取经纪商代码以及交易行情服务器地址。
2. 在[vn.py社区论坛]（https://www.vnpy.com/forum/）注册获得VN Station账号密码（论坛账号密码即是）
2. 在[vn.py社区论坛](https://www.vnpy.com/forum/)注册获得VN Station账号密码（论坛账号密码即是）
3. 启动VN Station（安装VNConda后会在桌面自动创建快捷方式），输入上一步的账号密码登录
@ -195,25 +195,25 @@ if __name__ == "__main__":
vn.py使用Github托管其源代码，如果希望贡献代码请使用github的PR（Pull Request）的流程:
1. [创建 Issue]（https://github.com/vnpy/vnpy/issues/new） - 对于较大的改动（如新功能，大型重构等）最好先开issue讨论一下，较小的improvement（如文档改进，bugfix等）直接发PR即可
1. [创建 Issue](https://github.com/vnpy/vnpy/issues/new) - 对于较大的改动（如新功能，大型重构等）最好先开issue讨论一下，较小的improvement（如文档改进，bugfix等）直接发PR即可
2. Fork [vn.py]（https://github.com/vnpy/vnpy） - 点击右上角**Fork**按钮
2. Fork [vn.py](https://github.com/vnpy/vnpy) - 点击右上角**Fork**按钮
3. Clone你自己的fork: ```git clone https://github.com/$userid/vnpy.git```
* 如果你的fork已经过时，需要手动sync：[https://help.github.com/articles/syncing-a-fork/]（https://help.github.com/articles/syncing-a-fork/）
* 如果你的fork已经过时，需要手动sync：[同步方法](https://help.github.com/articles/syncing-a-fork/)
4. 从**dev**创建你自己的feature branch: ```git checkout -b $my_feature_branch dev```
5. 在$my_feature_branch上修改并将修改push到你的fork上
6. 创建从你的fork的$my_feature_branch分支到主项目的**dev**分支的[Pull Request] - [在此]（https://github.com/vnpy/vnpy/compare?expand=1）点击**compare across forks**，选择需要的fork和branch创建PR
6. 创建从你的fork的$my_feature_branch分支到主项目的**dev**分支的[Pull Request] - [在此](https://github.com/vnpy/vnpy/compare?expand=1)点击**compare across forks**，选择需要的fork和branch创建PR
7. 等待review, 需要继续改进，或者被Merge!
在提交代码的时候，请遵守以下规则，以提高代码质量：
* 使用[autopep8]（https://github.com/hhatto/autopep8）格式化你的代码。运行```autopep8 --in-place --recursive . ```即可。
* 使用[flake8]（https://pypi.org/project/flake8/）检查你的代码，确保没有error和warning。在项目根目录下运行```flake8```即可。
* 使用[autopep8](https://github.com/hhatto/autopep8)格式化你的代码。运行```autopep8 --in-place --recursive . ```即可。
* 使用[flake8](https://pypi.org/project/flake8/)检查你的代码，确保没有error和warning。在项目根目录下运行```flake8```即可。
@ -231,10 +231,10 @@ vn.py使用Github托管其源代码，如果希望贡献代码请使用github的
## 其他内容
* [获取帮助]（https://github.com/vnpy/vnpy/blob/dev/docs/SUPPORT.md）
* [社区行为准侧]（https://github.com/vnpy/vnpy/blob/dev/docs/CODE_OF_CONDUCT.md）
* [Issue模板]（https://github.com/vnpy/vnpy/blob/dev/docs/ISSUE_TEMPLATE.md）
* [PR模板]（https://github.com/vnpy/vnpy/blob/dev/docs/PULL_REQUEST_TEMPLATE.md）
* [获取帮助](https://github.com/vnpy/vnpy/blob/dev/docs/SUPPORT.md)
* [社区行为准侧](https://github.com/vnpy/vnpy/blob/dev/docs/CODE_OF_CONDUCT.md)
* [Issue模板](https://github.com/vnpy/vnpy/blob/dev/docs/ISSUE_TEMPLATE.md)
* [PR模板](https://github.com/vnpy/vnpy/blob/dev/docs/PULL_REQUEST_TEMPLATE.md)