Merge lp:~arosales/charms/trusty/ibm-mq/update-readme into lp:~ibmcharmers/charms/trusty/ibm-mq/trunk

[Antonio Rosales]

Updates to the readme per comments in the bug @ https://bugs.launchpad.net/charms/+bug/1432489

Unmerged revisions

39. By Antonio Rosales on 2015-04-15

Update readme.

=== modified file 'README.md'
--- README.md	2015-04-09 09:36:17 +0000
+++ README.md	2015-04-15 22:56:30 +0000
@@ -12,7 +12,7 @@
 
 
 This charm installs IBM MQ product and configures it's IP Address and default
-port number (1414). MQ Administrators can setup queue managers 
+port number (1414). MQ Administrators can setup queue managers
 and queues. This will allow IBM MQ client application to transmit/receive messages.
 
 More information on IBM MQ  available [here](http://www-03.ibm.com/software/products/en/ibm-mq)
@@ -23,40 +23,43 @@
 
 Download your licensed IBM MQ 8.0.0.2 software and extract it's contents to files/archives directory of MQ charm.
 
-For e.g: 
-     Go to the files files/archive directory
-     Copy the WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar.gz file to this directory
-
-     gunzip WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar.gz (Ensure to you have a backup copy of this file)
-     tar xvf WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar
-     rm WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar
+    cd file/archive
+    cp WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar.gz .
+
+Ensure to you have a backup copy of this file.
+
+    gunzip WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar.gz
+    tar xvf WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar
+    rm WS_MQ_8.0.0.2_FOR_LIN_ON_LE_POWER.tar
 
 To install the downloaded binaries you must agree to the IBM license.  The license file(s) can be found under the files/archives directory on extraction of IBM MQ software. The license can also be viewed by running the following command after extracting IBM MQ to the files/archives directory:
+
       ./mqlicense.sh -text_only
 
 Run the following to deploy this charm:
 
-    juju deploy ibm-mq 
+    juju deploy ibm-mq
 
-At this point the charm will wait until the user accepts the license.  If you 
+At this point the charm will wait until the user accepts the license.  If you
 agree to the license, run the following command:
 
     juju set ibm-mq accept-ibm-mq-license=True
 
-In order to create MQ objects like queue, it is required that some 
+In order to create MQ objects like queue, it is required that some
 of the system configurations be updated. Details provided at:
 [here](http://www-01.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.ins.doc/q008550_.htm?lang=en).  
 
-The Charm updates the following system configuration- 
-/etc/sysctl.conf:
-    fs.file-max = 524288
-    kernel.shmmax = 268435456
-
-/etc/security/limits.conf 
-    mqm              hard    nofile          10240
-    mqm              soft    nofile          10240
-
-Adds user 'ubuntu' to group 'mqm'. 
+The Charm updates the following system configuration:
+
+    /etc/sysctl.conf:
+        fs.file-max = 524288
+        kernel.shmmax = 268435456
+
+    /etc/security/limits.conf
+        mqm              hard    nofile          10240
+        mqm              soft    nofile          10240
+
+    Adds user 'ubuntu' to group 'mqm'.
 
 Verify these changes have been made successfully if MQ throws up any errors.
 
@@ -64,12 +67,13 @@
 -------------
 
 `accept-ibm-mq-license`  
-Before you can use or install IBM MQ, 
-you must accept the terms of International License 
-Agreement for Non-Warranted Programs and additional license information. 
+Before you can use or install IBM MQ,
+you must accept the terms of International License
+Agreement for Non-Warranted Programs and additional license information.
 Please read the license agreement carefully.  
 
 The license file(s) can be found under the files/archives directory after downloading and extracting IBM MQ there. The license can also be viewed by running the following command after extracting IBM MQ to the files/archives directory:
+
       ./mqlicense.sh -text_only
 
 Set the value of accept-ibm-mq-license to True if you agree to IBM MQ license.
@@ -94,6 +98,7 @@
 
 (3) License Information
 License information for IBM MQ  is available as part of the downloaded product package. The license can be viewed by running the following command after extracting IBM MQ:
+
       ./mqlicense.sh -text_only
 
 License for the development version is available [here](http://www14.software.ibm.com/cgi-bin/weblap/lap.pl?popup=Y&li_formnum=L-APIG-9BUHAE&accepted_url=http://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqadv/mqadv_dev80_linux_x86-64.tar.gz)
@@ -101,4 +106,3 @@
 # Contact Information
 
 For issues with this charm, please contact [e-mail]
-