summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormbkma <[email protected]>2020-11-19 00:21:56 +0100
committerRobert Antoni Buj Gelonch <[email protected]>2020-11-20 11:56:11 +0100
commitd65993cad3792b7e46c51f8e8b8e51662151e93e (patch)
tree8413ce0c478c4cd1a22dd1783a367bac9cf29553 /README.md
parent8b1b53b247b70c7506bb60aa40c32010c4aac6a2 (diff)
downloadmate-calc-d65993cad3792b7e46c51f8e8b8e51662151e93e.tar.bz2
mate-calc-d65993cad3792b7e46c51f8e8b8e51662151e93e.tar.xz
Update Readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 23 insertions, 17 deletions
diff --git a/README.md b/README.md
index 0a19e6b..a745d7b 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,14 @@
-# Introduction.
+# MATE Calculator
-This is `mate-calc`, a fork of `gnome-calc`, the calculator application
-that was previously in the OpenWindows Deskset of the Solaris 8
-operating system.
-
-It incorporates a multiple precision arithmetic packages based on the
-work of Professor Richard Brent, who has also kindly given me
-permission to make it available.
+![mate-calc-icon](mate-calc.png)
-There is a single graphics driver for Gtk3 included with this release.
-
-## Getting started.
-
-The manual pages also describe how to use `mate-calc` in detail.
+## General Information
+MATE Calculator (*mate-calc*) started as a fork of *gnome-calc*, the calculator application
+that was previously in the OpenWindows Deskset of the Solaris 8
+operating system.
-## Calctool history.
+## Calctool history
Calctool was a project I worked on before I joined the OpenWindows
DeskSet engineering group at Sun. It was originally released to
@@ -42,15 +35,28 @@ application that is a part of CDE (albeit I had nothing to do with
that).
With its inclusion in the MATE CVS repository, it was renamed to
-`mate-calc`.
+*mate-calc*.
More recently, Sami Pietila provided arithmetic precedence support and
Robert Ancell converted the UI to use Glade.
+## Build/Installation
+
+MATE Calculator requires GTK+ (>= 3.22) and the [GNU MPFR](https://www.mpfr.org/) and [GNU MPC](http://www.multiprecision.org/mpc) libraries. For a complete list of dependencies see the [build.yml](https://github.com/mate-desktop/mate-calc/blob/master/.build.yml).
+
+Simple install procedure:
+
+```
+$ ./autogen.sh # Build configuration
+$ make # Build
+[ Become root if necessary ]
+$ make install # Installation
+```
+
-## Acknowledgements.
+## Acknowledgements
-See the AUTHORS file.
+See the [AUTHORS](https://github.com/mate-desktop/mate-calc/blob/master/AUTHORS) file.
Suggestions for further improvement would be most welcome, plus bug
reports and comments.