READMEs refined for each image

Part of SeleniumHQ#5

Author: mtscout6

Base/README.md

@@ -1,10 +1,34 @@
 # Selenium Base Image
 
-This image is not meant to be run directly! It serves as the base image used for each of the Selenium images involved in setting up a Selenium Grid.
+_This image is not meant to be run directly!_ It serves as the base image used for each of the Selenium images involved in setting up a Selenium Grid.
+
+## Dockerfile
+
+[`selenium/base` Dockerfile](https://github.com/SeleniumHQ/docker-selenium/blob/master/Base/Dockerfile)
 
 ## What is Selenium?
 _Selenium automates browsers._ That's it! What you do with that power is entirely up to you. Primarily, it is for automating web applications for testing purposes, but is certainly not limited to just that. Boring web-based administration tasks can (and should!) also be automated as well.
 
 Selenium has the support of some of the largest browser vendors who have taken (or are taking) steps to make Selenium a native part of their browser. It is also the core technology in countless other browser automation tools, APIs and frameworks.
 
 See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage within your test code.
+
+## License
+
+View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
+
+## Getting Help
+
+### User Group
+
+The first place where people ask for help about Selenium is the [Official User Group](https://groups.google.com/forum/#!forum/selenium-users). Here, you'll find that most of the time, someone already found the problem you are facing right now, and usually reached the solution for which you are looking.
+
+_Note: Please make sure to search the group before asking for something. Your question likely won't get answered if it was previously answered in another discussion!_
+
+### Chat Room
+
+The best place to ask for help is the user group (because they also keep the information accessible for others to read in the future). However, if you have a very important (or too simple) issue that needs a solution ASAP, you can always enter the IRC chat room. You might just find someone ready to help on `#selenium` at [Freenode](https://freenode.net/).
+
+### Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/SeleniumHQ/docker-selenium/issues). If you have any problems with or questions about Selenium, please contact us through Selenium's [But Tracker](https://code.google.com/p/selenium/issues/list).

Hub/README.md

@@ -2,6 +2,10 @@
 
 The Hub receives a test to be executed along with information on which browser and 'platform' where the test should be run. The hub will use this information and delegate to a node that can service those needs.
 
+## Dockerfile
+
+[`selenium/hub` Dockerfile](https://github.com/SeleniumHQ/docker-selenium/blob/master/Hub/Dockerfile)
+
 ## How to use this image
 
 ```
@@ -21,3 +25,23 @@ _Selenium automates browsers._ That's it! What you do with that power is entirel
 Selenium has the support of some of the largest browser vendors who have taken (or are taking) steps to make Selenium a native part of their browser. It is also the core technology in countless other browser automation tools, APIs and frameworks.
 
 See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage within your test code.
+
+## License
+
+View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
+
+## Getting Help
+
+### User Group
+
+The first place where people ask for help about Selenium is the [Official User Group](https://groups.google.com/forum/#!forum/selenium-users). Here, you'll find that most of the time, someone already found the problem you are facing right now, and usually reached the solution for which you are looking.
+
+_Note: Please make sure to search the group before asking for something. Your question likely won't get answered if it was previously answered in another discussion!_
+
+### Chat Room
+
+The best place to ask for help is the user group (because they also keep the information accessible for others to read in the future). However, if you have a very important (or too simple) issue that needs a solution ASAP, you can always enter the IRC chat room. You might just find someone ready to help on `#selenium` at [Freenode](https://freenode.net/).
+
+### Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/SeleniumHQ/docker-selenium/issues). If you have any problems with or questions about Selenium, please contact us through Selenium's [But Tracker](https://code.google.com/p/selenium/issues/list).

Makefile

@@ -24,13 +24,13 @@ firefox: nodebase
 	cd ./NodeFirefox && docker build -t $(NAME)/node-firefox:$(VERSION) .
 
 generate_chromedebug:
-	cd ./NodeDebug && ./generate.sh NodeChromeDebug node-chrome $(VERSION)
+	cd ./NodeDebug && ./generate.sh NodeChromeDebug node-chrome Chrome $(VERSION)
 
 chromedebug: generate_chromedebug chrome
 	cd ./NodeChromeDebug && docker build -t $(NAME)/node-chrome-debug:$(VERSION) .
 
 generate_firefoxdebug:
-	cd ./NodeDebug && ./generate.sh NodeFirefoxDebug node-firefox $(VERSION)
+	cd ./NodeDebug && ./generate.sh NodeFirefoxDebug node-firefox Firefox $(VERSION)
 
 firefoxdebug: generate_firefoxdebug firefox
 	cd ./NodeFirefoxDebug && docker build -t $(NAME)/node-firefox-debug:$(VERSION) .

NodeBase/README.md

@@ -0,0 +1,48 @@
+# Selenium Grid Node Base
+
+_This image is not meant to be run directly!_ It serves as the base image used for Selenium Nodes.
+
+## Dockerfile
+
+[`selenium/node-base` Dockerfile](https://github.com/SeleniumHQ/docker-selenium/blob/master/NodeBase/Dockerfile)
+
+## How to use this image
+
+First, you will need a Selenium Grid Hub that the Node will connect to.
+
+```
+$ docker run -d -P --name selenium-hub selenium/hub
+```
+
+Once the hub is up and running will want to launch nodes that can run tests. You can run as many nodes as you wish.
+
+```
+$ docker run -d --link selenium-hub:hub selenium/node-firefox
+```
+
+## What is Selenium?
+_Selenium automates browsers._ That's it! What you do with that power is entirely up to you. Primarily, it is for automating web applications for testing purposes, but is certainly not limited to just that. Boring web-based administration tasks can (and should!) also be automated as well.
+
+Selenium has the support of some of the largest browser vendors who have taken (or are taking) steps to make Selenium a native part of their browser. It is also the core technology in countless other browser automation tools, APIs and frameworks.
+
+See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage within your test code.
+
+## License
+
+View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
+
+## Getting Help
+
+### User Group
+
+The first place where people ask for help about Selenium is the [Official User Group](https://groups.google.com/forum/#!forum/selenium-users). Here, you'll find that most of the time, someone already found the problem you are facing right now, and usually reached the solution for which you are looking.
+
+_Note: Please make sure to search the group before asking for something. Your question likely won't get answered if it was previously answered in another discussion!_
+
+### Chat Room
+
+The best place to ask for help is the user group (because they also keep the information accessible for others to read in the future). However, if you have a very important (or too simple) issue that needs a solution ASAP, you can always enter the IRC chat room. You might just find someone ready to help on `#selenium` at [Freenode](https://freenode.net/).
+
+### Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/SeleniumHQ/docker-selenium/issues). If you have any problems with or questions about Selenium, please contact us through Selenium's [But Tracker](https://code.google.com/p/selenium/issues/list).

NodeChrome/README.md

@@ -2,6 +2,10 @@
 
 Selenium Node configured to run Google Chrome.
 
+## Dockerfile
+
+[`selenium/node-chrome` Dockerfile](https://github.com/SeleniumHQ/docker-selenium/blob/master/NodeChrome/Dockerfile)
+
 ## How to use this image
 
 First, you will need a Selenium Grid Hub that the Node will connect to.
@@ -22,3 +26,23 @@ _Selenium automates browsers._ That's it! What you do with that power is entirel
 Selenium has the support of some of the largest browser vendors who have taken (or are taking) steps to make Selenium a native part of their browser. It is also the core technology in countless other browser automation tools, APIs and frameworks.
 
 See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage within your test code.
+
+## License
+
+View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
+
+## Getting Help
+
+### User Group
+
+The first place where people ask for help about Selenium is the [Official User Group](https://groups.google.com/forum/#!forum/selenium-users). Here, you'll find that most of the time, someone already found the problem you are facing right now, and usually reached the solution for which you are looking.
+
+_Note: Please make sure to search the group before asking for something. Your question likely won't get answered if it was previously answered in another discussion!_
+
+### Chat Room
+
+The best place to ask for help is the user group (because they also keep the information accessible for others to read in the future). However, if you have a very important (or too simple) issue that needs a solution ASAP, you can always enter the IRC chat room. You might just find someone ready to help on `#selenium` at [Freenode](https://freenode.net/).
+
+### Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/SeleniumHQ/docker-selenium/issues). If you have any problems with or questions about Selenium, please contact us through Selenium's [But Tracker](https://code.google.com/p/selenium/issues/list).

NodeChromeDebug/README.md

@@ -0,0 +1,71 @@
+# Selenium Grid Node - Chrome Debug
+
+_This image is only intended for development purposes!_ Runs a Selenium Grid Node with a VNC Server to allow you to visually see the browser being automated. Since it runs additional services to support this it is too heavy weight for usage within a Selenium Grid cluster.
+
+## Dockerfile
+
+[`selenium/node-chrome-debug` Dockerfile](https://github.com/SeleniumHQ/docker-selenium/blob/master/NodeChromeDebug/Dockerfile)
+
+## How to use this image
+
+First, you will need a Selenium Grid Hub that the Node will connect to.
+
+```
+$ docker run -d -P --name selenium-hub selenium/hub
+```
+
+Once the hub is up and running will want to launch nodes that can run tests.
+
+```
+$ docker run -d -P --link selenium-hub:hub selenium/node-chrome-debug
+```
+
+You can acquire the port that the VNC server is exposed to by running:
+
+``` bash
+$ docker port <container-name|container-id> 5900
+#=> 0.0.0.0:49338
+```
+
+Using RealVNC you can look in view only mode, to avoid accidentally messing up your tests, utilizing our [vncview script](https://github.com/SeleniumHQ/docker-selenium/blob/master/bin/vncview).
+
+``` bash
+$ ./bin/vncview 127.0.0.1:49338
+```
+
+If you are running Boot2Docker on Mac then you already have a [VNC client](http://www.davidtheexpert.com/post.php?id=5) built-in. You can connect by entering `vnc://<boot2docker-ip>:49160` in Safari or [Alfred](http://www.alfredapp.com/)
+
+When you are prompted for the password it is __secret__. If you wish to change this then you should either change it in the `/NodeBase/Dockerfile` and build the images yourself, or you can define a docker image that derives from the posted ones which reconfigures it:
+
+``` dockerfile
+FROM selenium/node-chrome-debug:2.44.0
+
+RUN x11vnc -storepasswd <your-password-here> /home/seluser/.vnc/passwd
+```
+
+## What is Selenium?
+_Selenium automates browsers._ That's it! What you do with that power is entirely up to you. Primarily, it is for automating web applications for testing purposes, but is certainly not limited to just that. Boring web-based administration tasks can (and should!) also be automated as well.
+
+Selenium has the support of some of the largest browser vendors who have taken (or are taking) steps to make Selenium a native part of their browser. It is also the core technology in countless other browser automation tools, APIs and frameworks.
+
+See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage within your test code.
+
+## License
+
+View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
+
+## Getting Help
+
+### User Group
+
+The first place where people ask for help about Selenium is the [Official User Group](https://groups.google.com/forum/#!forum/selenium-users). Here, you'll find that most of the time, someone already found the problem you are facing right now, and usually reached the solution for which you are looking.
+
+_Note: Please make sure to search the group before asking for something. Your question likely won't get answered if it was previously answered in another discussion!_
+
+### Chat Room
+
+The best place to ask for help is the user group (because they also keep the information accessible for others to read in the future). However, if you have a very important (or too simple) issue that needs a solution ASAP, you can always enter the IRC chat room. You might just find someone ready to help on `#selenium` at [Freenode](https://freenode.net/).
+
+### Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/SeleniumHQ/docker-selenium/issues). If you have any problems with or questions about Selenium, please contact us through Selenium's [But Tracker](https://code.google.com/p/selenium/issues/list).

NodeDebug/README.template.md

@@ -0,0 +1,71 @@
+# Selenium Grid Node - ##BROWSER## Debug
+
+_This image is only intended for development purposes!_ Runs a Selenium Grid Node with a VNC Server to allow you to visually see the browser being automated. Since it runs additional services to support this it is too heavy weight for usage within a Selenium Grid cluster.
+
+## Dockerfile
+
+[`selenium/##BASE##-debug` Dockerfile](https://github.com/SeleniumHQ/docker-selenium/blob/master/##FOLDER##/Dockerfile)
+
+## How to use this image
+
+First, you will need a Selenium Grid Hub that the Node will connect to.
+
+```
+$ docker run -d -P --name selenium-hub selenium/hub
+```
+
+Once the hub is up and running will want to launch nodes that can run tests.
+
+```
+$ docker run -d -P --link selenium-hub:hub selenium/##BASE##-debug
+```
+
+You can acquire the port that the VNC server is exposed to by running:
+
+``` bash
+$ docker port <container-name|container-id> 5900
+#=> 0.0.0.0:49338
+```
+
+Using RealVNC you can look in view only mode, to avoid accidentally messing up your tests, utilizing our [vncview script](https://github.com/SeleniumHQ/docker-selenium/blob/master/bin/vncview).
+
+``` bash
+$ ./bin/vncview 127.0.0.1:49338
+```
+
+If you are running Boot2Docker on Mac then you already have a [VNC client](http://www.davidtheexpert.com/post.php?id=5) built-in. You can connect by entering `vnc://<boot2docker-ip>:49160` in Safari or [Alfred](http://www.alfredapp.com/)
+
+When you are prompted for the password it is __secret__. If you wish to change this then you should either change it in the `/NodeBase/Dockerfile` and build the images yourself, or you can define a docker image that derives from the posted ones which reconfigures it:
+
+``` dockerfile
+FROM selenium/##BASE##-debug:2.44.0
+
+RUN x11vnc -storepasswd <your-password-here> /home/seluser/.vnc/passwd
+```
+
+## What is Selenium?
+_Selenium automates browsers._ That's it! What you do with that power is entirely up to you. Primarily, it is for automating web applications for testing purposes, but is certainly not limited to just that. Boring web-based administration tasks can (and should!) also be automated as well.
+
+Selenium has the support of some of the largest browser vendors who have taken (or are taking) steps to make Selenium a native part of their browser. It is also the core technology in countless other browser automation tools, APIs and frameworks.
+
+See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage within your test code.
+
+## License
+
+View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
+
+## Getting Help
+
+### User Group
+
+The first place where people ask for help about Selenium is the [Official User Group](https://groups.google.com/forum/#!forum/selenium-users). Here, you'll find that most of the time, someone already found the problem you are facing right now, and usually reached the solution for which you are looking.
+
+_Note: Please make sure to search the group before asking for something. Your question likely won't get answered if it was previously answered in another discussion!_
+
+### Chat Room
+
+The best place to ask for help is the user group (because they also keep the information accessible for others to read in the future). However, if you have a very important (or too simple) issue that needs a solution ASAP, you can always enter the IRC chat room. You might just find someone ready to help on `#selenium` at [Freenode](https://freenode.net/).
+
+### Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/SeleniumHQ/docker-selenium/issues). If you have any problems with or questions about Selenium, please contact us through Selenium's [But Tracker](https://code.google.com/p/selenium/issues/list).

NodeDebug/generate.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 FOLDER=../$1
 BASE=$2
-VERSION=$3
+BROWSER=$3
+VERSION=$4
 
 rm -rf $FOLDER
 mkdir -p $FOLDER
@@ -17,3 +18,8 @@ sed 's/^xvfb-run/sudo -E -i -u seluser \\\
 mv $FOLDER/entry_point.sh.tmp $FOLDER/entry_point.sh
 
 cat ./debug-script.sh >> $FOLDER/entry_point.sh
+
+cat ./README.template.md \
+  | sed "s/##BROWSER##/$BROWSER/" \
+  | sed "s/##BASE##/$BASE/" \
+  | sed "s/##FOLDER##/$1/" > $FOLDER/README.md