From 1e0af788bba8ca039d29002cf96c23d56d7d5f33 Mon Sep 17 00:00:00 2001
From: Mark Grant <m.grant.prg@gmail.com>
Date: Sun, 1 Apr 2018 11:17:20 +0100
Subject: [PATCH] Enhance README file.

Improve project description.
Improve AutoTools installation section.
Add Ubuntu PPA installation section.
Add Debian and Raspbian installation instructions.
---
 README | 72 +++++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 61 insertions(+), 11 deletions(-)

diff --git a/README b/README
index 1fdd8f7..bd39d46 100644
--- a/README
+++ b/README
@@ -1,34 +1,52 @@
+--------
 Contents
 ========
 
 1 ... Project Description
 
-2 ... Installation
+2 ... AutoTools (configure and make) Installation
+
+3 ... Ubuntu Installation
+
+4 ... Debian and Raspbian Installation
 
--------------------------
 
+
+-------------------------
 1 ... Project Description
 =========================
 
 This is a simple script to reduce repetitive typing of some apt-get maintenance
 commands.
-It reduces the daily maintenance commands to one command - this script.
 
----------------------
+The script sequentially invokes:-
+	apt-get upgrade
+	apt-get autoclean
+	apt-get check
+	apt-get autoremove
 
-2 ... Installation
-==================
+For the 'apt-get upgrade' command to have an up to date impact, agmaint should
+be run soon after an 'apt-get update' has been performed.
 
-1 ... Extract the tarball (.tar.gz file) preserving the directory structure.
+agmaint must be run with root privileges.
 
-2 ... cd to the directory created.
 
-2 ... As root or sudo, type './configure'
+-------------------------------------------------
+2 ... AutoTools (configure and make) Installation
+=================================================
 
-3 ... As root or sudo, type 'make install clean'
+1 ... Download the tarball (the .tar.gz file) from:-
+	https://github.com/m-grant-prg/agmaint/releases
 
-(Quote marks are for textual clarity only).
+2 ... Extract the tarball preserving the directory structure.
 
+3 ... cd to the directory created.
+
+4 ... Type './configure'
+
+5 ... As root or sudo, type 'make install clean'
+
+(Quote marks are for textual clarity only).
 
 
 To uninstall the package:
@@ -36,3 +54,35 @@ To uninstall the package:
 1 ... cd to the directory created in the above install process.
 
 2 ... As root or sudo, type 'make uninstall clean'
+
+
+-------------------------
+3 ... Ubuntu Installation
+=========================
+This script is available as an Ubuntu package hosted in a Personal Package
+Archive (PPA). If you add this PPA to your software sources then you can easily
+install, update and remove the package.
+
+To view the details of this PPA please follow the link below:-
+	https://code.launchpad.net/~m-grant-prg/+archive/ubuntu/utils
+
+To add this PPA to your system please type the following:-
+	sudo add-apt-repository ppa:m-grant-prg/utils
+	sudo apt-get update
+
+To install this script on your system for use please type the following:-
+	sudo apt-get update
+	sudo apt-get install agmaint
+
+To uninstall this package at any time please type:-
+	sudo apt-get remove agmaint
+
+
+--------------------------------------
+4 ... Debian and Raspbian Installation
+======================================
+Debian and Raspbian '.deb' packages can be downloaded from:-
+	https://github.com/m-grant-prg/agmaint/releases
+
+They can then be installed using a utility such as GDebi which is available in
+the standard repos.