Permalink
Browse files

Merge pull request #7 from zacc/modify_readme

Update readmes
  • Loading branch information...
2 parents a5155da + 3a98777 commit 4ddc2a77ccec70e1fe89c75fedd506f7e3f49e6f zacc committed Jan 24, 2012
Showing with 11 additions and 9 deletions.
  1. +7 −5 README.md
  2. +4 −4 templateREADME.md
View
@@ -1,11 +1,13 @@
Mozilla WebQA Test Templates
============================
-This repository holds templates for creating new tests so they can be used with Mozilla Selenium projects.
+This repository holds a template of Mozilla's framework for creating WebDriver tests.
-## test_file.py
-This contains a template to create a test file to hold test cases
+The framework has been developed by Mozilla and is used across many of our automated
+testing projects. It is designed to provide clear page objects and readable tests.
-## page_object.py
-This contains a template to create a Page Objects for a project
+The template doubles as a working, albeit very basic, test suite which can gives
+you a working base to build on from the moment you checkout the template.
+For further information and tutorials consult the wiki on github:
+https://github.com/mozilla/mozwebqa-test-templates/wiki
View
@@ -28,7 +28,7 @@ follow `sudo easy_install pip` with `sudo pip install virtualenv`, and then
create and activate a [virtualenv](http://www.virtualenv.org) (e.g. `virtualenv
<PROJECT_NAME>-tests-env; source <PROJECT_NAME>-tests-env/bin/activate`) to
create a clean "virtual environment" for just this project. Then you can
-`pip install -r requiremenst/requirements.txt` in your virtual environment
+`pip install -r requirements.txt` in your virtual environment
without needing to use `sudo`.
If you don't mind installing globally, just run:
@@ -37,7 +37,7 @@ If you don't mind installing globally, just run:
followed by:
- sudo pip install -r <LOCATION_OF_REQUIREMENTS_FILE>
+ sudo pip install -r requirements.txt
__note__
@@ -61,7 +61,7 @@ Change the path/name to the downloaded Selenium server file.
Once the above prerequisites have been met, you can run the tests using the
following command:
- py.test --api=<SELENIUM_API> --baseurl=<BASE_URL> --browser=*firefox
+ py.test --browsername=*firefox --browserver=8 --platform=<LINUX|WINDOWS|MACOS>
For other possible options, type `py.test --help`.
@@ -76,5 +76,5 @@ we'd like to ask you to do:
3. Fork this project with your own GitHub account
4. Make sure all tests are passing, and submit a pull request with your changes
-[GitHub Templates]: https://github.com/AutomatedTester/mozwebqa-test-templates
+[GitHub Templates]: https://github.com/mozilla/mozwebqa-test-templates
[Style Guide]: https://wiki.mozilla.org/QA/Execution/Web_Testing/Docs/Automation/StyleGuide

0 comments on commit 4ddc2a7

Please sign in to comment.