summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-21 17:04:31 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-23 07:19:43 +0000
commitc82791004e8a207ef7bbe4567d8c3e54af84a8fd (patch)
treeef8f236d944b80188f2b8a97bfb0f90873ff4a8b /docs
parent05ef2c4f46a9dc7a704a290eb15817c80a52c2e6 (diff)
Cleanup DEVELOP.md
- remove unecessary content - move CLI develop guide to rst document Change-Id: I20b6f458aa13f1feb1764e6c4d096ec8a9dddf49 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs')
-rw-r--r--docs/testing/developer/design/cli.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/testing/developer/design/cli.rst b/docs/testing/developer/design/cli.rst
index 7b226e6f..487bdec5 100644
--- a/docs/testing/developer/design/cli.rst
+++ b/docs/testing/developer/design/cli.rst
@@ -1,2 +1,24 @@
- Which framework has been used and why
- How to extend to more commands
+
+Original content from DEVELOP.md
+
+ ### CLI
+
+ Click currently supports Bash completion. The prerequisite for this is that the program
+ needs to be installed correctly. To install Qtip, execute the following command in root
+ folder of Qtip:
+
+ ```
+ cd <project root>
+ pip install -e .
+ ```
+
+ Once the installation has been completed successfully, the following needs to be added to
+ the `.bashrc` file:
+
+ ```
+ eval "$(_QTIP_COMPLETE=source qtip)"
+ ```
+
+ The above would activate command completion for Qtip.