Format README.md and remove a duplicated README
authorZhiqiang Zhang <zhiqiang.zhang@intel.com>
Fri, 29 Aug 2014 02:31:20 +0000 (10:31 +0800)
committerZhiqiang Zhang <zhiqiang.zhang@intel.com>
Fri, 29 Aug 2014 02:31:20 +0000 (10:31 +0800)
README [deleted file]
README.md

diff --git a/README b/README
deleted file mode 100644 (file)
index 45e3f69..0000000
--- a/README
+++ /dev/null
@@ -1,134 +0,0 @@
-Dependency:
-=================
-1. python2.7
-
-2. python-setuptools python-support python-pip
-
-   Ubuntu
-
-        sudo apt-get install python-setuptools python-support python-pip
-
-   Fedora(RHEL)
-
-        sudo yum install python-setuptools python-support python-pip
-
-   openSUSE(TIZEN)
-
-        sudo zypper install python-setuptools python-support python-pip
-
-
-
-3. python-requests(>=1.1), use pip to install it
-       
-        sudo pip install requests
-
-How to build debian package:
-=================
-Host with Ubuntu OS recommended. Run the command below to build from source code and get debian package: 
-       dpkg-buildpackage
-
-
-How to build RPM package:
-=================
-Host with Fedora OS recommended. Run the command below to build from source code and get rpm package: 
-       make -C packaging/
-       rpmbuild -tb packaging/testkit-lite_<version>.tar.gz --nodeps
-
-Host with ubuntu OS, we need to add a workaround to support the rpm build
-
-       rpmbuild --define 'python_sitelib /usr/lib/python2.7/site-packages' -tb packaging/testkit-lite_<version>.tar.gz --nodeps
-
-How to install:
-=================
-Install testkit lite from source code: 
-
-       sudo python setup.py install --record /var/log/testkit-lite.files
-
-Install testkit lite from debian build: 
-
-       sudo dpkg -i ../testkit-lite_<version>_all.deb
-
-How to uninstall:
-=================
-Uninstall testkit-lite installed with 'setup.py install':
-       cat /var/log/testkit-lite.files | sudo xargs rm -rf
-
-Uninstall testkit-lite installed with 'debian': 
-
-       sudo dpkg -r testkit-lite
-
-How to use:
-=================
-1) You can run case on target:
-For web test cases:
-   
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -e 'WRTLauncher <package_name>'
-
-For native test cases:
-   
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" 
-
-2) You can run case in single mode :
-For web test cases:
-   
-       testkit-lite -f "<somewhere>/<package_name>/tests.xml" -e 'WRTLauncher <package_name>' --comm localhost
-
-For native test cases:
-            
-       testkit-lite -f "<somewhere>/<package_name>/tests.xml" --comm localhost
-    
-3) You can select on parser engine to simply conduct one or more tests.xml on target:
-
-       testkit-lite -f device:"<somewhere>/<package_name1>/tests.xml ... <somewhere>/<package_namen>/tests.xml" -e 'WRTLauncher <package_name1> ... <package_namen>'
-4) If you want to execute both auto and manual tests:
-            
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml"
-            
-5) If you just want to execute manual tests:
-
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -M
-            
-6) If you just want to execute auto tests:
-
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -A
-            
-7) If you want to save test result to another file, by default it'll be under /opt/testkit/lite/latest:
-
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -o <somewhere>/xxx.xml
-            
-8) If you want to choose some filters:
-
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" --status level1 --type type1 ...
-
-9) If you want to run test according capability:
-            
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" --capability capability.xml
-            
-10) At last, you can freely compose the above parameters together:
-             
-       testkit-lite -f <somewhere1>/tests.xml <somewhere2>/tests.xml -A --priority P1 --type type1 ...
-
-Get Results:
-=================
-Test report will be generated as tests.result.xml.The result will be under /opt/testkit/lite/latest after execution, you can also check the history results in /opt/testkit/lite/yyyy-mm-dd-HH:MM:SS.NNNNNN.
-
-View Results:
-=================
-
-Test report can be viewed in HTML format, so the data in the xml result file looks more human friendly.
-
-Please follow the following steps to view test report:
-
-    1) copy files: application.js back_top.png jquery.min.js testresult.xsl tests.css under directory /opt/testkit/lite/xsd/
-    
-    2) put the files from step 1) under the same directory as the xml result file
-    
-    3) open xml result file with a web browser(IE, Chrome or Firefox)
-
-Known Issues:
-=================
-N/A
index 45e3f69..1ced010 100644 (file)
--- a/README.md
+++ b/README.md
-Dependency:
-=================
-1. python2.7
+## Dependency:
 
+1. python2.7
 2. python-setuptools python-support python-pip
+   1. Ubuntu
+      `sudo apt-get install python-setuptools python-support python-pip`
+   2. Fedora(RHEL)
+      `sudo yum install python-setuptools python-support python-pip`
+   3. openSUSE(TIZEN)
+      `sudo zypper install python-setuptools python-support python-pip`
+3. python-requests(>=1.1)
+   `sudo pip install requests`
+
+## How to build Debian package:
+
+Host with Ubuntu OS recommended.
+
+Run the command below to build from source code and get Debian package:
+
+`dpkg-buildpackage`
+
+## How to build RPM package:
+
+Host with Fedora OS recommended.
+
+Run the command below to build from source code and get RPM package:
 
-   Ubuntu
+```
+make -C packaging/
+rpmbuild -tb packaging/testkit-lite_<version>.tar.gz --nodeps
+```
 
-        sudo apt-get install python-setuptools python-support python-pip
+Host with Ubuntu OS, we need to add a workaround to support the RPM build:
 
-   Fedora(RHEL)
+`rpmbuild --define 'python_sitelib /usr/lib/python2.7/site-packages' -tb packaging/testkit-lite_<version>.tar.gz --nodeps`
 
-        sudo yum install python-setuptools python-support python-pip
+## How to install:
 
-   openSUSE(TIZEN)
+Install testkit lite from source code:
 
-        sudo zypper install python-setuptools python-support python-pip
+`sudo python setup.py install --record /var/log/testkit-lite.files`
 
+Install testkit lite from debian build:
 
+`sudo dpkg -i ../testkit-lite_<version>_all.deb`
 
-3. python-requests(>=1.1), use pip to install it
-       
-        sudo pip install requests
+## How to uninstall:
 
-How to build debian package:
-=================
-Host with Ubuntu OS recommended. Run the command below to build from source code and get debian package: 
-       dpkg-buildpackage
+Uninstall testkit-lite installed with `setup.py install`:
 
+`cat /var/log/testkit-lite.files | sudo xargs rm -rf`
 
-How to build RPM package:
-=================
-Host with Fedora OS recommended. Run the command below to build from source code and get rpm package: 
-       make -C packaging/
-       rpmbuild -tb packaging/testkit-lite_<version>.tar.gz --nodeps
+Uninstall testkit-lite installed with `debian`:
 
-Host with ubuntu OS, we need to add a workaround to support the rpm build
+`sudo dpkg -r testkit-lite`
 
-       rpmbuild --define 'python_sitelib /usr/lib/python2.7/site-packages' -tb packaging/testkit-lite_<version>.tar.gz --nodeps
+## How to use:
 
-How to install:
-=================
-Install testkit lite from source code: 
+1. You can run case on target:
+   1. For web test cases:
 
-       sudo python setup.py install --record /var/log/testkit-lite.files
+   `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -e 'WRTLauncher <package_name>'`
 
-Install testkit lite from debian build: 
+   2. For native test cases:
 
-       sudo dpkg -i ../testkit-lite_<version>_all.deb
+     `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml"`
 
-How to uninstall:
-=================
-Uninstall testkit-lite installed with 'setup.py install':
-       cat /var/log/testkit-lite.files | sudo xargs rm -rf
+2. You can run case in single mode :
+   1. For web test cases:
 
-Uninstall testkit-lite installed with 'debian': 
+      `testkit-lite -f "<somewhere>/<package_name>/tests.xml" -e 'WRTLauncher <package_name>' --comm localhost`
 
-       sudo dpkg -r testkit-lite
+   2. For native test cases:
 
-How to use:
-=================
-1) You can run case on target:
-For web test cases:
-   
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -e 'WRTLauncher <package_name>'
+      `testkit-lite -f "<somewhere>/<package_name>/tests.xml" --comm localhost`
 
-For native test cases:
-   
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" 
+3. You can select on parser engine to simply conduct one or more `tests.xml` on target:
 
-2) You can run case in single mode :
-For web test cases:
-   
-       testkit-lite -f "<somewhere>/<package_name>/tests.xml" -e 'WRTLauncher <package_name>' --comm localhost
+   `testkit-lite -f device:"<somewhere>/<package_name1>/tests.xml ... <somewhere>/<package_namen>/tests.xml" -e 'WRTLauncher <package_name1> ... <package_namen>'`
 
-For native test cases:
-            
-       testkit-lite -f "<somewhere>/<package_name>/tests.xml" --comm localhost
-    
-3) You can select on parser engine to simply conduct one or more tests.xml on target:
+4. If you want to execute both auto and manual tests:
 
-       testkit-lite -f device:"<somewhere>/<package_name1>/tests.xml ... <somewhere>/<package_namen>/tests.xml" -e 'WRTLauncher <package_name1> ... <package_namen>'
-4) If you want to execute both auto and manual tests:
-            
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml"
-            
-5) If you just want to execute manual tests:
+   `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml"`
 
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -M
-            
-6) If you just want to execute auto tests:
+5. If you just want to execute manual tests:
 
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -A
-            
-7) If you want to save test result to another file, by default it'll be under /opt/testkit/lite/latest:
+   `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -M`
 
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -o <somewhere>/xxx.xml
-            
-8) If you want to choose some filters:
+6. If you just want to execute auto tests:
 
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" --status level1 --type type1 ...
+   `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -A`
 
-9) If you want to run test according capability:
-            
-       testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" --capability capability.xml
-            
-10) At last, you can freely compose the above parameters together:
-             
-       testkit-lite -f <somewhere1>/tests.xml <somewhere2>/tests.xml -A --priority P1 --type type1 ...
+7. If you want to save test result to another file, by default it'll be under `/opt/testkit/lite/latest`:
 
-Get Results:
-=================
-Test report will be generated as tests.result.xml.The result will be under /opt/testkit/lite/latest after execution, you can also check the history results in /opt/testkit/lite/yyyy-mm-dd-HH:MM:SS.NNNNNN.
+   `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" -o <somewhere>/xxx.xml`
 
-View Results:
-=================
+8. If you want to choose some filters:
+
+   `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" --status level1 --type type1 ...`
+
+9. If you want to run test according capability:
+
+   `testkit-lite -f device:"<somewhere>/<package_name>/tests.xml" --capability capability.xml`
+
+10. At last, you can freely compose the above parameters together:
+
+    `testkit-lite -f <somewhere1>/tests.xml <somewhere2>/tests.xml -A --priority P1 --type type1 ...`
+
+## Get Results:
+
+Test report will be generated as tests.result.xml.The result will be under `/opt/testkit/lite/latest` after execution, you can also check the history results in `/opt/testkit/lite/yyyy-mm-dd-HH:MM:SS.NNNNNN`.
+
+## View Results:
 
 Test report can be viewed in HTML format, so the data in the xml result file looks more human friendly.
 
 Please follow the following steps to view test report:
 
-    1) copy files: application.js back_top.png jquery.min.js testresult.xsl tests.css under directory /opt/testkit/lite/xsd/
-    
-    2) put the files from step 1) under the same directory as the xml result file
-    
-    3) open xml result file with a web browser(IE, Chrome or Firefox)
+1. Copy files: `application.js back_top.png jquery.min.js testresult.xsl tests.css` under directory `/opt/testkit/lite/xsd/`
+2. Put the files from step 1) under the same directory as the xml result file
+3. Open xml result file with a web browser(IE, Chrome or Firefox)
+
+## Known Issues:
 
-Known Issues:
-=================
 N/A