Skip to content

Commit 925597b

Browse files
committed
Update README
1 parent 627dcb8 commit 925597b

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The split into two daemons is required as notifications can only be sent on a pe
2020

2121
## Installation
2222

23-
If you have an Arch Linux or Debian based distributions, have a look at the [releases page][releases] for official packages.
23+
If you have an Arch Linux (Manjaro, ...) or Debian (Ubuntu, ...) based distribution, have a look at the [releases page][releases] for official packages.
2424
After installation you may want to:
2525
- enable the systemd service for the system daemon using `systemctl enable surface-dtx-daemon.service`.
2626
- enable the systemd service for the per-user daemon using `systemctl enable --user surface-dtx-userd.service`.
@@ -39,5 +39,24 @@ All options are explanined in these files, the configuration language is TOML, d
3939

4040
Furthermore, a per-user configuration for the user daemon can also be created under `$XDG_CONFIG_HOME/surface-dtx/surface-dtx-userd.conf` (if not set, `$XDG_CONFIG_HOME` defaults to `.config`).
4141

42+
## Building a Package from Source
43+
44+
### Arch Linux
45+
46+
Use the PKGBUILD under `pkg/arch`, i.e. to build a pakcage and directly install it run
47+
```
48+
cd pkg/arch && makepkg -fsi
49+
```
50+
51+
### Debian/Ubuntu
52+
53+
Use the `makedeb` script provided under `pkg/deb`, i.e. run
54+
```
55+
./pkg/deb/makedeb
56+
```
57+
from the root project directory.
58+
You may need to install the `build-essential` and `devscripts` packages beforehand.
59+
The final package will be in the `pkg/deb` directory.
60+
4261

4362
[releases]: https://github.com/qzed/linux-surface-dtx-daemon/releases

0 commit comments

Comments
 (0)