From b25ec056abe5242201282827f12b43c6fcbed6ae Mon Sep 17 00:00:00 2001 From: Colin Clark Date: Wed, 4 Aug 2021 11:08:50 +0100 Subject: [PATCH] Minor documentation updates Remove Travis CI from the README (it is no longer supported by GitHub) Other minor README text changes Ensure the Lua API html is generated correctly Improve the text for the exif rotation section of the Help file --- README.md | 18 ++++++++++-------- doc/create-doxygen-lua-api.sh | 2 ++ doc/docbook/GuideFaq.xml | 4 ++-- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 35d2ec46..dc555ed9 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,6 @@ This is Geeqie, a successor of GQview. -[![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie) - Geeqie has been forked from GQview project, because it was not possible to contact the GQview author and only maintainer. @@ -25,6 +23,8 @@ Geeqie is currently considered stable. Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie@freelists.org) or open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues). +(Unless you first subscribe to the mailing list, you will not receive automated responses) + Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie). The project website is and you will find the latest sources in the @@ -32,14 +32,14 @@ The project website is and you will find the latest sou # README contents: -* Description / Features +* Features * Downloading * Installation -* Notes and changes for this release +* Notes and changes for the latest release * Requirements -## Description / Features +## Features Geeqie is a graphics file viewer. Basic features: @@ -66,7 +66,7 @@ Geeqie is a graphics file viewer. Basic features: * Collections. -* support for stereoscopic images +* Support for stereoscopic images * input: side-by-side (JPS) and MPO format * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV) @@ -105,11 +105,13 @@ Animated GIFs are supported. Geeqie is available: -* as a package with some distributions. +* as a package for Linux and BSD systems (See the [project web page](https://www.geeqie.org)). * as a [flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home). -* as an [AppImage](https://cclark.uk/Geeqie). +* 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. However Geeqie is stable and you may compile the latest version from sources. diff --git a/doc/create-doxygen-lua-api.sh b/doc/create-doxygen-lua-api.sh index 38c92edf..b32fabff 100755 --- a/doc/create-doxygen-lua-api.sh +++ b/doc/create-doxygen-lua-api.sh @@ -36,6 +36,8 @@ export PROJECT="Geeqie" export VERSION=$(git tag --list v[1-9]* | tail -1) export SRCDIR="$PWD/.." export DOCDIR="$PWD/html/lua-api" +export INLINE_SOURCES=NO +export STRIP_CODE_COMMENTS=YES TMPFILE=$(mktemp) || exit 1 diff --git a/doc/docbook/GuideFaq.xml b/doc/docbook/GuideFaq.xml index 3185d1b8..b1e9aa83 100644 --- a/doc/docbook/GuideFaq.xml +++ b/doc/docbook/GuideFaq.xml @@ -67,7 +67,7 @@ option. - Write altered image orientation to the metadata not set + Write altered image orientation to the metadata - not set: If you change the orientation of an image using any of the available commands, the image will always be displayed in the modified orientation. This new orientation is stored in temporary data structures associated with each image file. When Geeqie closes, these changes will be lost. @@ -80,7 +80,7 @@ is selected, any images which have Exif orientation data will also be shown rotated. However, any rotation you have selected manually will always over-ride the embedded Exif rotation value. - Write altered image orientation to the metadata set + Write altered image orientation to the metadata - set: If you change the orientation of an image using any of the available commands, this new orientation is stored in a metadata write queue. -- 2.20.1