add 'Developing' section to README

This commit is contained in:
Jussi Kuokkanen 2023-07-24 18:54:05 +03:00
parent 0ede9e5bdf
commit cd2ec6c0a3

View File

@ -21,4 +21,24 @@ git submodule update
meson build <meson options>
cd build
ninja && sudo ninja install
```
# Developing
There are a few scripts in `dev/` for development convenience, mainly to deal with DBus. A separate DBus instance and custom config file is used, so the TuxClocker daemon is able to be registered without installing service files into the system.
Note: the following scripts assume TuxClocker is installed to `inst/`, so `meson` should be called as follows:
`meson build --prefix=$(pwd)/inst`
The scripts should be used in this order (they all have to be running simultaneously, so probably best to run in separate terminals):
`dev/dbus-start.sh` Starts a separate DBus instance.
`dev/tuxclockerd-start.sh` Launches `tuxclockerd` making it connect to our separate DBus instance and LD_LIBRARY_PATH set to find the built `libtuxclocker`.
`dev/gui-start.sh` Launches the TuxClocker GUI making it connect to our separate DBus instance, so it can find the TuxClocker DBus service.
You can also use a program like `d-feet` if you are only making changes to the daemon. (To be documented)