mirror of
https://github.com/jtgans/g13gui.git
synced 2025-06-20 00:14:09 -04:00
Update README with more details
This commit is contained in:
parent
9eb6cc6b05
commit
428a3faf44
47
README.md
47
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
|
||||
|
||||
[](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
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user