Merge pull request #1063 from utPLSQL/feature/install_doc_update

jgebal · web-flow · commit 4be8465fd948 · 2020-03-27T21:48:36.000Z
Restructuring utPSLQL install guide.
diff --git a/docs/userguide/install.md b/docs/userguide/install.md
@@ -1,10 +1,36 @@
 ![version](https://img.shields.io/badge/version-v3.1.11.3367--develop-blue.svg)
 
-# Downloading latest version of utPLSQL
+# Supported database versions
+
+utPLSQL is continuously tested against following versions of Oracle databases
+* 11g R2 
+* 12c
+* 12c R2
+* 18c
+* 19c
+
+We do our best to assure full compatibility with supported versions of Oracle databases [See](http://www.oracle.com/us/support/library/lifetime-support-technology-069183.pdf#page=6)
+
+# Downloading utPLSQL
+
+## Manual download
+
+- Go to GitHub releases page for utPLSQL [`https://github.com/utPLSQL/utPLSQL/releases`](https://github.com/utPLSQL/utPLSQL/releases)
+- Choose the version to download - latest is always greatest
+- Download one of files
+    - utPLSQL.tar.gz
+    - utPLSQL.zip
+    
+The files have identical content but use different compression (tar / zip ) so choose whichever you prefer depending on your platform (Win/Mac/Unix/Linux). 
+
 
-To download latest version of utPLSQL from github on both Unix/Linux as well as Windows machines use the below snippets.
+## Scripted download of latest utPLSQL version
 
-## Unix/Linux
+The below snippets can be used to download latest version of utPLSQL from github releases.
+
+After downloading follow the installation instructions in next sections of this document.
+
+### Unix/Linux
 
 ```bash
 #!/bin/bash
@@ -22,7 +48,7 @@ You may download with a one-liner if that is more convenient.
 curl -LOk $(curl --silent https://api.github.com/repos/utPLSQL/utPLSQL/releases/latest | awk '/browser_download_url/ { print $2 }' | grep ".zip\"" | sed 's/"//g') 
 ```
 
-## Windows
+### Windows
 
 To run the script on windows you will need [PowerShell 3.0](https://blogs.technet.microsoft.com/heyscriptingguy/2013/06/02/weekend-scripter-install-powershell-3-0-on-windows-7/) or above. 
 You will also need .NET 4.0 Framework or above.
@@ -51,29 +77,6 @@ foreach ($i in $urlList) {
 }
 ```
 
-# Checking environment and utPLSQL version
-
-To check the framework version execute the following query:
-```sql
-select substr(ut.version(),1,60) as ut_version from dual;
-```
-
-Additionally you may retrieve more information about your environment by executing the following query:
-```sql
-select 
-  xmlserialize( content xmltype(ut_run_info()) as clob indent size = 2 )
-  from dual;
-```
-
-# Supported database versions
-
-The utPLSQL may be installed on any supported version of Oracle Database [see](http://www.oracle.com/us/support/library/lifetime-support-technology-069183.pdf#page=6)
-* 11g R2 
-* 12c
-* 12c R2
-* 18c
-* 19c
-
 # Headless installation
 
 utPLSQL can be installed with DDL trigger, to enable tracking of DDL changes to your unit test packages.
@@ -235,6 +238,20 @@ The following tools that support the SQL*Plus commands can be used to run the in
   - [SQLcl](http://www.oracle.com/technetwork/developer-tools/sqlcl/overview/index.html)
   - [Oracle SQL Developer](http://www.oracle.com/technetwork/developer-tools/sql-developer/overview/index.html)
  
+# Checking environment and utPLSQL version
+
+To check the framework version execute the following query:
+```sql
+select substr(ut.version(),1,60) as ut_version from dual;
+```
+
+Additionally you may retrieve more information about your environment by executing the following query:
+```sql
+select 
+  xmlserialize( content xmltype(ut_run_info()) as clob indent size = 2 )
+  from dual;
+```
+
 # Additional requirements
 
 In order to use the Code Coverage functionality of utPLSQL, users executing the tests must have the CREATE privilege on the PLSQL code that the coverage is gathered on.
