Add Tools.md documentation
Changes:
- Split the tools section to new Tools.md.
- Add section in README.md referencing new Tools.md.
Change-Id: I4035189b74650a48782ac211e5a0fa8bd76906e8
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/README.md b/README.md
index 7cbf3d2..a765f4f 100755
--- a/README.md
+++ b/README.md
@@ -51,6 +51,7 @@
- [REST-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md): Quick reference for some common
curl commands required for testing.
- [README.md](https://github.com/openbmc/phosphor-webui/blob/master/README.md): Web UI setup reference.
+ - [Tools.md](Tools.md): Reference information for helper tools.
## Testing Setup Steps ##
@@ -233,43 +234,3 @@
```
$ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests
```
-
-**Tools**
-
-* Github script:
-
- Command to get GitHub issues (any GitHub repository) report in CSV format:
-
- Note: On Prompt "Enter your GitHub Password:" enter your GitHub password.
-
- Usage:
- ```
- $ cd tools/
- $ python github_issues_to_csv <github user> <github repo>
- ```
- Example for getting openbmc issues:
- ```
- $ python github_issues_to_csv <github user> openbmc/openbmc
- ```
- Example for getting openbmc-test-automation issues:
- ```
- $ python github_issues_to_csv <github user> openbmc/openbmc-test-automation
- ```
-
-* Generate Robot test cases documentation:
-
- Usage:
- ```
- $ ./generate_test_document <Robot test directory path> <test case document file path>
- ```
-
- Example for generating tests cases documentation for tests directory:
- ```
- $ ./generate_test_document tests testsdirectoryTCdocs.html
- ```
-
- Example for generating tests cases documentation (tests, gui, extended TCs):
- Note: Invoke the tool without argument:
- ```
- $ ./generate_test_document
- ```
diff --git a/Tools.md b/Tools.md
new file mode 100755
index 0000000..b316bd9
--- /dev/null
+++ b/Tools.md
@@ -0,0 +1,39 @@
+## Tools available in OpenBMC Test Automation ##
+
+**This document describes the tools available in the /tools directory.**
+
+* Obtain a copy of GitHub issues in CSV format:
+
+ Note: You will be prompted to enter your GitHub password.
+
+ Usage:
+ ```
+ $ cd tools/
+ $ python github_issues_to_csv <github user> <github repo>
+ ```
+ Example for getting openbmc issues:
+ ```
+ $ python github_issues_to_csv <github user> openbmc/openbmc
+ ```
+ Example for getting openbmc-test-automation issues:
+ ```
+ $ python github_issues_to_csv <github user> openbmc/openbmc-test-automation
+ ```
+
+* Generate Robot test cases documentation:
+
+ Usage:
+ ```
+ $ ./generate_test_document <Robot test directory path> <test case document file path>
+ ```
+
+ Example for generating tests cases documentation for tests directory:
+ ```
+ $ ./generate_test_document tests testsdirectoryTCdocs.html
+ ```
+
+ Example for generating tests cases documentation:
+ Note: Invoke the tool without arguments:
+ ```
+ $ ./generate_test_document
+ ```