diff --git a/README.rst b/README.rst index 1bc6b4235058dc61d77f0df8ff8f43d7a5a07adf..edddbd2e81f4345f794190d6364df7f55142f18f 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ =================================== -Libvirt test provider for virt-test +Libvirt Test Provider for virt-test =================================== This is the official test provider [1]_ for the following @@ -10,12 +10,12 @@ subtest types: * V2V * Libguestfs -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:: cp io-github-autotest-libvirt.ini myprovider.ini @@ -33,19 +33,19 @@ Really quick start guide [v2v] subdir: v2v/ - 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 .py -6. Ensure are met -7. Fix any problems -8. Push your changes and submit a pull request +6. Ensure are met. +7. Fix any problems. +8. Push your changes and submit a pull request. 9. 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.