Improve READMEs

Author: patrickfournier

README.md

@@ -1,45 +1,68 @@
 # Gorfector
 
-General Observable Record Freight Extractor (**Gorfector**) is an image scanning software.
+[![Ubuntu Latest Build and Test](https://github.com/patrickfournier/gorfector/actions/workflows/ubuntu-latest-build-test.yml/badge.svg)](https://github.com/patrickfournier/gorfector/actions/workflows/ubuntu-latest-build-test.yml)
+
+The General Observable Record Freight Extractor (**Gorfector**) is an image scanning software.
 
 Being relatively new, it has not been tested with a lot of scanners yet. Currently, it is known to work with:
 
 - Epson Perfection V600 Photo
 
 However, it should work with any scanner that supports the SANE protocol. Please report any issues you encounter with
-other scanners so we can improve compatibility.
+your scanner so we can improve compatibility.
 
 ## Features
 
-- User-friendly scan parameter presentation
+- User-friendly scan parameters presentation
 - Zoomable, high-resolution previews
-- Batch scanning of a single document (useful for scanning negatives)
+- Batch scanning of multiple areas in a single document (useful for scanning negatives)
 - User defined presets
 - Output to file (TIFF, PNG, JPEG), to email or to printer
-- Adwaita GTK3 user interface
+- Adwaita/GTK4 user interface
 - Saves pixels straight from the scanner: no image processing is done
 
+[![The main window of Gorfector](data/metainfo/main.png)](data/metainfo/main.png)
+*The main window of Gorfector*
+
+[![Scanning multiple areas](data/metainfo/scan_list.png)](data/metainfo/scan_list.png)
+*Scanning multiple areas*
+
+# Installation
+
+## AppImage
+
+On Ubuntu 24.04, download the latest AppImage from the 
+[release page](https://github.com/patrickfournier/gorfector/releases). 
+
+On other platforms, try the AppImage; if it does not work, you will need to build **Gorfector** from source. 
+See the [Compiling](#compiling) section for more information.
+
+## Flatpak
+
+There is no flatpak package available because flatpak does not work well with SANE. It would require 
+the **Gorfector** package to include the drivers for all scanners, which is not realistic.
+
 # Improving Gorfector
 
 You can help improve **Gorfector**!
 
 ## Add support for your scanner
 
-**Gorfector** uses a JSON file to define how to present the parameters of your scanner. This file is also used to
-translate the parameters into the current user language. If there is no JSON file for your scanner, **Gorfector** will use 
-the parameters as provided by the scanner. This means they will probably be presented in English, and some
-parameters may not make sense or could be too advanced (this was the case for the Epson Perfection V600 Photo scanner).
+**Gorfector** uses a JSON file to define how to present the parameters of the scanner. This file is also used to
+translate the parameters into the current user language. If there is no JSON file for the scanner you are using, 
+**Gorfector** will use the parameters as provided by the scanner. This means they will probably be presented in English, 
+and some parameters may not make sense or could be too advanced.
 
-To improve the parameter presentation for your scanner, you need to create a JSON file that defines their presentation. See
-the file [SCANNER_SUPPORT.md](SCANNER_SUPPORT.md) for more information on how to create the JSON file. If you do so, please consider 
-submitting a pull request with the JSON file so that others can benefit from your work.
+To improve the parameter presentation for a scanner, you need to create a JSON file that defines their presentation. See
+the file [SCANNER_SUPPORT.md](SCANNER_SUPPORT.md) for more information on how to create this file. If you do create a new scanner file,
+please consider submitting a pull request so that others can benefit from your work.
 
 ## Add support for your language
 
 **Gorfector** uses a PO file to define the translations for the user interface. See the file
 [TRANSLATE.md](TRANSLATE.md) for more information on how to create or update the PO file. 
 If you add or improve language support, please consider submitting
-a pull request with the PO file so that others can use **Gorfector** in your language.
+a pull request so that others can use **Gorfector** in their language.
 
 ## Submit a bug report
 
@@ -54,13 +77,21 @@ This will help avoid duplicate work and ensure that the changes are
 in line with the goals of the project. See the file [CONTRIBUTING.md](CONTRIBUTING.md) 
 for more information on how to contribute code.
 
+## Contributing AppImages binaries
+
+If you find out that the AppImage you downloaded does work on your system, please let us know by creating an issue on the
+[GitHub repository](https://github.com/patrickfournier/gorfector/issues).
+
+If you want to contribute an AppImage binary for your system, please fork the repository, create an AppImage
+using the scripts in the `build-aux/appimage` directory, and create a pull request.
+
 # Compiling
 
 ## Setup
 
 To compile **Gorfector**, you need to have the following tools installed:
 
-- Meson
+- Meson 1.1.0 or later
 - Gettext
 - `libxml2-utils`
 - `desktop-file-utils`
@@ -73,29 +104,34 @@ On Ubuntu, you can install these tools with the following command:
   sudo apt install build-essential meson gettext libxml2-utils desktop-file-utils itstool
 ```
 
+If you are using a different distribution, you will need to install the equivalent packages for your distribution.
 Then you will need to install the following dependencies:
 
-- GLib, GTK4 and Adwaita
+- GTK 4.14 or later
+- `libadwaita` 1.5 or later
 - `libsane`
-- `libtiff`
-- `libpng`
-- `libjpeg`
+- `libtiff` 4.5 or later
+- `libpng` 1.6 or later
+- `libjpeg` 2.1 or later
 
-On Ubuntu, you can install these dependencies with the following command:
+On Ubuntu 24.04, you can install these dependencies with the following command:
 (`libjpeg` will be pulled by `libtiff`):
 
 ```bash
   sudo apt install libglib2.0-dev-bin libgtk-4-dev libadwaita-1-dev libsane-dev libtiff-dev libpng-dev
 ```
 
+If you are using a different distribution, you will need to install the equivalent packages for your distribution.
+
 Finally, you will need to clone the repository:
 
 ```bash
   git clone git@github.com:patrickfournier/gorfector.git
   cd gorfector
 ```
 
-Configure `git` to use the local hooks directory, to check the code formatting before each commit:
+If you plan to contribute code, you should also set up a local hooks directory to check the code formatting 
+before each commit.
 
 ```bash
   git config --local core.hooksPath .githooks/
@@ -104,32 +140,25 @@ Configure `git` to use the local hooks directory, to check the code formatting b
 ## Build
 
 **Gorfector** uses `meson` to build the project. To build **Gorfector**, run the 
-following commands (replace `<install_dir>` with the directory where you want to 
-install **Gorfector**):
+following commands (replace `<build-dir>` with the directory where you want to build **Gorfector**
+and `<install_dir>` with the directory where you want to install it):
 
 ```bash
-  meson setup build --prefix=<install_dir>
-  cd build
-  meson build scanner_settings
-  meson build gorfector-pot
-  meson build gorfector-update-po
-  meson build gorfector-gmo
-  meson build gorfector
-  meson build gorfector-tests
+  meson setup <build-dir> --prefix=<install_dir>
+  cd <build-dir>
   meson install
 ```
 
 To run the tests, run the following command:
 
 ```bash
-  meson test -C build
+  meson test -C <build-dir>
 ```
 
 ## Running
 
 To use **Gorfector**, power up your scanner and run the following command:
 
 ```bash
-  cd <install_dir>/bin
-  ./gorfector
+  <install_dir>/bin/gorfector
 ```

help/README.txt

@@ -0,0 +1,5 @@
+To add a new translation:
+
+- Add the name of the new language to the `LINGUAS` file.
+- Build the `help-gorfector-update-po` target to create the new .po file.
+- Edit the new .po file.