diff --git a/Readme.md b/Readme.md index 68b135c..9833730 100644 --- a/Readme.md +++ b/Readme.md @@ -2,39 +2,71 @@ A gem that contains generators that create things testers need. -Currently it only generates a cucumber project. You can do this by executing: +First install the gem by running the following in the terminal: + + gem install testgen + +By default it only generates a cucumber project. You can do this by executing: testgen project - -This command will create a project in the project_name directory with the files needed to begin -developing cucumber features. There are options that can be provided to have the project configure to use different gems. Here are a few: + +This command will create a project in the project_name directory with the files and directory structure needed +to begin developing cucumber features. + +``` +my_project_name +├── Gemfile +├── Rakefile +├── cucumber.yml +└── features + ├── step_definitions + └── support + ├── env.rb + ├── hooks.rb + └── pages +``` + +There are options that can be provided to configure the project to use different gems. Below are the options available: ## Web testing -If you are testing a web application, testgen will by default setup the project to use the PageObject gem -with Watir. +If you are testing a web application, testgen will by default setup the project to use +the [page-object](https://github.com/cheezy/page-object) gem with +[Watir](http://watir.com/). testgen project - + ## Android testing -If you want to setup project to use the Appium library +If you want to setup project to use the [Appium](https://github.com/appium/ruby_lib) library testgen project --with-appium ## Native Windows testing -If you are testing a native windows application, testgen can setup the project to use the Mohawk gem. +If you are testing a native windows application, testgen can setup the project to use +the [Mohawk](https://github.com/leviwilson/mohawk) gem. testgen project --with-mohawk - ## Moving page-objects or screen-objects to the lib directory -There is another option available with will create the page or screen directory in a base directoy named lib. It will also setup the project so these files get loaded the same way they would if the directory was in the support directory. Here's an example of creating a project for web testing using the lib option: - - testgen project --pageobject-driver=watir --with-lib - - - - +There is another option available which will create the page or screen directory in a base directory named lib. +It will also setup the project so that these files get loaded the same way they would if the directory was in the +support directory. Here's an example of creating a project for web testing using the lib option: + + testgen project --with-lib + +``` +my_project_name +├── Gemfile +├── Rakefile +├── cucumber.yml +├── features +│ ├── step_definitions +│ └── support +│ ├── env.rb +│ └── hooks.rb +└── lib + └── pages +```