Preparing for release v2.0.1
[geeqie.git] / README.md
index 018c231..26d10af 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,16 +15,17 @@ open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/is
 
 Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie).
 
-The project website is <http://www.geeqie.org/> and you will find the latest sources in the
+The project website is <https://www.geeqie.org/> and you will find the latest sources in the
 [Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
 
 ## Contents
 
 * [Features](#features)
 * [Downloading](#downloading)
-* [Installation](#manual-installation)
+* [Compiling and Installing](#compiling-and-installing)
 * [Notes and changes for the latest release](#notes-and-changes-for-the-latest-release)
 * [Requirements](#requirements)
+* [Required libraries](#required-libraries)
 
 ### Features
 
@@ -84,7 +85,7 @@ Geeqie is a graphics file viewer. Basic features:
 * Geeqie includes a 'find duplicates' tool which can compare images using a variety of criteria (filename, file size, visual similarity, dimensions, image content), either within a single folder or between two folders. Finding duplicates ignoring the rotation of images is also supported.
 * Images may be given a rating value (also known as a "star rating").
 
-* Maps from [OpenStreetMap](http://www.openstreetmap.org) may be displayed in a side panel. If an image has GPS coordinates embedded, its position will be displayed on the map - if Image Direction is encoded, that will be displayed also. If an image does not have embedded GPS coordinates, it may be dragged-and-dropped onto the map to encode its position.
+* Maps from [OpenStreetMap](https://www.openstreetmap.org) may be displayed in a side panel. If an image has GPS coordinates embedded, its position will be displayed on the map - if Image Direction is encoded, that will be displayed also. If an image does not have embedded GPS coordinates, it may be dragged-and-dropped onto the map to encode its position.
 
 * Speed of operation can be increased by caching thumbnails and similarity data of images. When Geeqie is run as a stand-alone command line program (`geeqie --cache-maintenance <path>`) these data will be recursively created from the defined start point. This program can be called from `cron` or `anacron` so that cache updating is automatically done at specified intervals.
 
@@ -100,7 +101,7 @@ Geeqie is available:
 
 * as an [AppImage](https://www.geeqie.org/AppImage/index.html) (Generated from the latest sources).
 
-* as a [Homebrew](https://formulae.brew.sh/formula/geeqie) package for macOS.
+* as a [Homebrew](https://formulae.brew.sh/formula/geeqie) or [MacPorts](https://ports.macports.org/port/geeqie) package for macOS.
 
 However Geeqie is stable and you may compile the latest version from sources.
 
@@ -128,28 +129,42 @@ Either: `git clone git://git.geeqie.org/geeqie.git`
 
 Or: `git clone http://git.geeqie.org/git/geeqie.git`
 
-### Manual Installation
+### Compiling and Installing
 
-List compile options: `./autogen.sh --help`
+`meson setup build`  
+`ninja -C build install`
 
-Common options:
-`./autogen.sh --disable-gtk3`,
+List compile options:  
+`meson configure build`
 
-Compilation: `./autogen.sh [options]; make -j`
+Apply options e.g.:  
+`sudo ninja -C build uninstall`  
+`meson configure -Dpdf=enable -Dwebp=disable`  
+`ninja -C build install`
 
-Install: `[sudo] make install`
+Re-display configuration data:  
+`ninja -C build reconfigure`
 
-Removal: `[sudo] make uninstall`
+Meaning of options:  
+`auto` If the library is not found, continue the installation  
+`enable` If the library is not found, stop the installation  
+`disable` Do not look for the library  
 
-#### Note
+Uninstall:  
+`sudo ninja -C build uninstall`
+
+Install new version:  
+`sudo ninja -C build uninstall`  
+`git pull`  
+`ninja -C build install`
 
-The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
+#### Note
 
 It is recommended to always use `git clone  git://git.geeqie.org/geeqie.git` to download Geeqie. After installing Geeqie you may delete the folder you have cloned Geeqie into.
 
 However if you leave the folder intact, whenever new features or patches are available, execute:
 
-`git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
+`sudo ninja -C build uninstall; git pull; ninja -C build install`
 
 Only the changed sources are downloaded, which makes this a quick operation.