From e50913476e9840790f5af69a60bbd170a23f74f8 Mon Sep 17 00:00:00 2001 From: gomico Date: Wed, 27 Oct 2021 06:31:27 +0000 Subject: [PATCH] update README.rst. improved writing style --- README.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 64364f33..5420640b 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ ================================ -QEMU test provider for virt-test +QEMU Test Provider for virt-test ================================ This is the official [1] test provider for the following @@ -9,12 +9,12 @@ subtest types: * Generic (Virtualization backend agnostic) * OpenVSwitch -Really quick start guide +Quick Start Guide ------------------------ -1) Fork this repo on github -2) Create a new topic branch for your work -3) Create a new test provider file in your virt test repo, +1) Fork this repo on github. +2) Create a new topic branch for your work. +3) Create a new test provider file in your virt-test repo, like: :: @@ -30,20 +30,20 @@ Really quick start guide subdir: qemu/ [openvswitch] subdir: openvswitch/ -You can optionally delete temporarily the -`io-github-autotest-qemu.ini` file, just so you don't have test +You can choose to temporarily delete the +`io-github-autotest-qemu.ini` file, so that you will not have test conflicts. Then you can develop your new test code, run it -using virt test, and commit your changes. +using virt-test, and commit your changes. -4) Make sure you have `inspektor installed. `_ +4) Make sure you have `inspektor `_ installed. 5) Run: :: inspekt checkall --disable-style E501,E265,W601,E402,E722,E741 --no-license-check -6) Fix any problems -7) Push your changes and submit a pull request +6) Fix any problems. +7) Push your changes and submit a pull request. 8) That's it. [1] You can always create your own test provider, if you have special purposes, or just want to develop your work independently. -- Gitee