hackclub/burrow
1
0
Fork 0
Code Pull requests Releases Packages Activity Actions 4
burrow/docs/GTK_APP.md
dav aaabca9957 Update docs and CI
2024-09-07 17:11:55 -07:00

2.9 KiB
Raw Permalink Blame History

Linux GTK App Getting Started

Currently, the GTK App can be built as a binary or as an AppImage. Note that the flatpak version can compile but will not run properly!

Dependencies

Install Build Dependencies

Debian

Note: Burrow currently cannot compile on Debian Stable (Bookworm) due to its outdated dependencies

  1. Install build dependencies
sudo apt install -y clang meson cmake pkg-config libgtk-4-dev libadwaita-1-dev gettext desktop-file-utils libsqlite3-dev protobuf-compiler libprotobuf-dev
  1. Install flatpak builder (Optional)
sudo apt install -y flatpak-builder
  1. Install AppImage build tools (Optional)
sudo apt install -y wget fuse file
Fedora
  1. Install build dependencies
sudo dnf install -y clang ninja-build cmake meson gtk4-devel glib2-devel libadwaita-devel desktop-file-utils libappstream-glib sqlite-devel protobuf-compiler protobuf-devel
  1. Install flatpak builder (Optional)
sudo dnf install -y flatpak-builder
  1. Install AppImage build tools (Optional)
sudo dnf install -y util-linux wget fuse fuse-libs file
Void Linux (glibc)
  1. Install build dependencies
sudo xbps-install -Sy gcc clang meson cmake pkg-config gtk4-devel gettext desktop-file-utils gtk4-update-icon-cache appstream-glib sqlite-devel protobuf protobuf-devel
  1. Install flatpak builder (Optional)
sudo xbps-install -Sy flatpak-builder
  1. Install AppImage build tools (Optional)
sudo xbps-install -Sy wget fuse file

Flatpak Build Dependencies (Optional)

flatpak install --user \
    org.gnome.Platform/x86_64/45 \
    org.freedesktop.Sdk.Extension.rust-stable/x86_64/23.08

Building

General
  1. Enter the burrow-gtk
cd burrow-gtk
  1. Perform the meson build
meson setup build
meson compile -C build
Flatpak
  1. Compile and install the flatpak
flatpak-builder
    --user --install --force-clean --disable-rofiles-fuse \
    flatpak_debug/ \
    burrow-gtk/build-aux/com.hackclub.burrow.devel.json
AppImage
  1. Enter the burrow-gtk
cd burrow-gtk
  1. Compile the AppImage
./build-aux/build_appimage.sh

Running

General

The compiled binary can be found in build/src/burrow-gtk.

./build/src/burrow-gtk
Flatpak 
flatpak run com.hackclub.burrow-devel
AppImage

The compiled binary can be found in build-appimage/Burrow-*.AppImage.

./build-appimage/Burrow-*.AppImage