Skip to content

Commit 19b9f99

Browse files
authored
Add a how it works section to the README (#34)
* Add a how it works section to the README * Fix formatting
1 parent 9ce1d78 commit 19b9f99

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,24 @@ This plugin requires the following dependencies in order to work properly:
3030
# call through linuxdeploy
3131
> ./linuxdeploy-x86_64.AppImage --appdir AppDir --plugin gtk --output appimage --icon-file mypackage.png --desktop-file mypackage.desktop
3232
```
33+
34+
35+
## How it Works
36+
37+
This plugin is written in bash and goes through a series of steps to make sure
38+
that all the libraries and other files are pulled in for GTK apps to work
39+
properly once in the AppImage. The steps include:
40+
41+
1. Detects the GTK version to use
42+
1. Installs itself as a hook in `$APPDIR/apprun-hooks`
43+
1. Uses `gsettings` to set a light or dark adwaita theme
44+
1. Installs the GLib schemas and then runs `glib-compile-schemas` on them
45+
1. Installs the GIRepository typelibs for gobject-introspection
46+
1. Copies the GTK libs and sets GTK path related environmental variables to
47+
1 locations in the APPDIR
48+
1. Updates the input method module registration (immodules) cache
49+
1. Installs the GDK Pixbuf libraries and cache, and then updates the cache
50+
1 using gdk-pixbuf-query-loaders
51+
1. Installs additional libraries including Gdk, GObject, Gio, librsvg, Pango,
52+
1 PangoCairo, and PangoFT2
53+
1. Manually sets the RPATH for the GTK modules

0 commit comments

Comments
 (0)