[gimp-macos-build] Documentation improvements



commit ceefdd5591917d5676a767ce62228e5ba2e0e72d
Author: Alex Samorukov <samm os2 kiev ua>
Date:   Thu Nov 7 09:04:41 2019 +0100

    Documentation improvements

 README.md | 33 +++++++++++++++++++--------------
 1 file changed, 19 insertions(+), 14 deletions(-)
---
diff --git a/README.md b/README.md
index c1df274..fd0093a 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# Build GIMP/OSX inside CircleCI
+# Build GIMP/macOS inside CircleCI
 
-This repository contains files related to GIMP/OSX build using CircleCI.
+This repository contains files related to GIMP/macOS build using CircleCI.
 
 ## Build process description
 
-To build GIMP/MacOS we are using [fork](https://gitlab.gnome.org/samm-git/gtk-osx/tree/gimp)
+To build GIMP/macOS we are using [fork](https://gitlab.gnome.org/samm-git/gtk-osx/tree/gimp)
 of the [gtk-osx](https://gitlab.gnome.org/GNOME/gtk-osx) project (`gimp` branch). 
 Fork adds modules related to GIMP and some gimp-specific patches to GTK.
 Currently build is done using CircleCI.
@@ -13,17 +13,17 @@ Because CircleCI is not supporting gitlab [yet] there is a [GitHub mirror](https
 
 ## Before you starting
 
-I found that GTK and GIMP builds on OSX are very fragile. If you have any other build system (brew, 
macports) installed - try to remove it first or at least isolate from jhbuild env as much as you can.
+I found that GTK and GIMP build process on macOS are very fragile. If you have any other build system (brew, 
MacPorts) installed - try to remove it first or at least isolate from the JHBuild environment as much as you 
can.
 
 I was able to get working builds in the VirtualBox VM, it works stable enough for me.
 
 ## Steps in the [CircleCI 
config.yml](https://github.com/GNOME/gimp-macos-build/blob/master/.circleci/config.yml) are:
 
-- Install gfortran and rust as they are required for the GIMP dependencies.
-- Setup OSX 10.9 SDK. This is needed to ensure that GIMP is able to run on MacOS 10.9+. See [this 
article](https://smallhacks.wordpress.com/2018/11/11/how-to-support-old-osx-version-with-a-recent-xcode/) for 
the details.
-- Setting up jhbuild with a custom `~/.config/jhbuildrc-custom` file (see 
https://github.com/GNOME/gimp-macos-build/blob/master/jhbuildrc-gtk-osx-gimp). As part of setup it is running 
`bootstrap-gtk-osx-gimp` jhbuild command to compile required modules to run jhbuild. Jhbuild is using Python3 
venv to run.
-- Install [fork of the gtk-mac-bundler](https://github.com/samm-git/gtk-mac-bundler/tree/fix-otool) - tool 
which helps to create MacOS application bundles for the GTK apps. Only difference with official one is [this 
PR](https://github.com/jralls/gtk-mac-bundler/pull/10)
-- Installing all gtk-osx, gimp and WebKit dependencies using jhbuild
+- Installs Python 3 and Rust as they are required for the GIMP dependencies.
+- Setup macOS 10.9 SDK. This is needed to ensure that GIMP can run on macOS 10.9+. See [this 
article](https://smallhacks.wordpress.com/2018/11/11/how-to-support-old-osx-version-with-a-recent-xcode/) for 
the details.
+- Setting up JHBuild with a custom `~/.config/jhbuildrc-custom` file (see 
https://github.com/GNOME/gimp-macos-build/blob/master/jhbuildrc-gtk-osx-gimp). As part of the setup, it is 
running `bootstrap-gtk-osx-gimp` JHBuild command to compile required modules to run JHBuild. JHBuild is using 
Python3 venv to run.
+- Install [fork of the gtk-mac-bundler](https://github.com/samm-git/gtk-mac-bundler/tree/fix-otool) - the 
tool which helps to create macOS application bundles for the GTK apps. The only difference with official one 
is [this PR](https://github.com/jralls/gtk-mac-bundler/pull/10)
+- Installing all gtk-osx, gimp and WebKit dependencies using JHBuild
 - Building WebKit v1. This step could be avoided as it takes a lot of time, this is a soft dependency.
 - Building GIMP and gimp-help (from git).
 - Importing signing certificate/key from the environment variables
@@ -31,11 +31,16 @@ I was able to get working builds in the VirtualBox VM, it works stable enough fo
   - Building package using `gtk-mac-bundler`
   - Using `install_name_tool` fixing all library path to make package relocatable.
   - generating debug symbols
-  - fixing pixmap and imm cache files to remove absolute pathnames
-  - compiles all py files to pyc to avoid writes to the Application folders
+  - fixing `pixmap` and `imm` cache files to remove absolute pathnames
+  - compiles all `.py` files to `.pyc` to avoid writes to the Application folder
   - Signing all binaries
-  - Creating DMG package using [create-dmg](https://github.com/andreyvit/create-dmg) tool and signing it
-- Uploading DMG to the CircleCI build artifacts
+  - Creating a DMG package using [create-dmg](https://github.com/andreyvit/create-dmg) tool and signing it 
and signing it
+- Uploading a DMG to the CircleCI build artifacts
+
+## Other related links
+
+ - [Gtk-OSX](https://gitlab.gnome.org/GNOME/gtk-osx/) project to simplify building MacOS application bundles 
for Gtk+-based applications
+ - [gimp-plugins-collection](https://github.com/aferrero2707/gimp-plugins-collection) -        GMIC, 
LiquidRescale, NUFraw, PhFGimp and ResynthesizerPlugin GIMP plugin builds, including macOS version
 
 ## Known bugs and limitations (merge requests are welcome!)
 
@@ -49,5 +54,5 @@ framework. Probably could be a small Python plugin as [there is a module](https:
 
 - `master`: latest GIMP release
 - `gimp-2-10`: gimp-2-10 build
-- `debug`: same as master, but with full debug symbols
+- `debug`: same as the `master`, but with full debug symbols
 - `hardened-runtime`: singed and notarized package with a hardened runtime enabled


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]