Skip to content

Commit

Permalink
Enhance README file.
Browse files Browse the repository at this point in the history
Improve project description.
Improve AutoTools installation section.
Add Ubuntu PPA installation section.
Add Debian and Raspbian installation instructions.
  • Loading branch information
m-grant-prg committed Apr 1, 2018
1 parent becb69b commit 1e0af78
Showing 1 changed file with 61 additions and 11 deletions.
72 changes: 61 additions & 11 deletions README
Original file line number Diff line number Diff line change
@@ -1,38 +1,88 @@
--------
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:

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.

0 comments on commit 1e0af78

Please sign in to comment.