From 428a3faf446b26e060868106425c77009f1cffb6 Mon Sep 17 00:00:00 2001 From: June Tate-Gans Date: Tue, 26 Mar 2024 08:56:18 -0500 Subject: [PATCH] Update README with more details --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/README.md b/README.md index 8c40887..8799930 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,50 @@ All wrapped up in a glorious Gtk 3.0 + libappindicator interface. Please note: this is an early version of the application and as such it is still in heavy development, but the author uses it almost on a daily basis already to play most of her game library. + +## Building + +[![Build Status](https://drone.hedron.io/api/badges/jtgans/g13gui/status.svg)](https://drone.hedron.io/jtgans/g13gui) + +We have a continuous build running to make packaging, and periodically those +artifacts are brought over as releases on the Github site. The CI is run on +June's personal infrastructure via a gitea mirror, so releases may lag behind +a slight bit. June promises to redouble her efforts. :D + +In general, though, g13gui is a python program, so no actual compilation takes +place. All the Makefile and associated infrastructure do is assemble distro +specific packages. If you want to skip the packaging (not recommended), it's +entirely possible to run the program out of the source tree by doing the +following: + +``` +[user@host g13gui]$ export PYTHONPATH=$PWD +[user@host g13gui]$ bin/g13gui & +[user@host g13gui]$ bin/g13-clock & +[user@host g13gui]$ bin/g13-profiles & +``` + +Note that you will have to manually install the udev rules file in `etc/` to +your appropriate distro-specific location. + +### Building a package + +In the major distributions, it should just be possible to run `make` to build +a package for your specific distro. As of this writing, there is support to +build for Debian, Ubuntu, Arch, and Manjaro. Patches are welcome to help improve +availability on other platforms. + +#### Debian and Debian derivatives + +First, setup your system with build tooling: + +``` +lupin:~$ sudo apt-get install devscripts python3 build-essential git-buildpackage appstream dh-sequence-python3 meson +``` + +Now you can build the package: + +``` +lupin:~/src/g13gui$ make +``` +