From 2e50264ffc7f19b18bae925ede53a699d8defb57 Mon Sep 17 00:00:00 2001
From: zhupr <zhu.pengrong@foxmail.com>
Date: Thu, 19 Nov 2020 11:08:47 +0800
Subject: [PATCH] add get_data.py docs

---
 scripts/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 scripts/README.md

diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 0000000000..46cecfdef0
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1,29 @@
+# Download Qlib Data
+
+
+## Download CN Data
+
+```bash
+python get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn
+```
+
+## Downlaod US Data
+
+> The US stock code contains 'PRN', and the directory cannot be created on Windows system
+
+```bash
+python get_data.py qlib_data --target_dir ~/.qlib/qlib_data/us_data --region us
+```
+
+## Download CN Simple Data
+
+```bash
+python get_data.py qlib_data --name qlib_data_simple --target_dir ~/.qlib/qlib_data/cn_data --region cn
+```
+
+## Help
+
+```bash
+python get_data.py qlib_data --help
+```
+