Skip to content

Commit bc1079d

Browse files
committed
Update build options
1 parent 3487f5e commit bc1079d

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,16 +93,31 @@ Since v1.0.0, the use of ydotoold is mandatory.
9393
## Build
9494
**CMake 3.22+ is required.**
9595

96+
### Build options
97+
There are a few extra options that can be configured when running CMake
98+
99+
- BUILD_DOCS=ON|OFF - whether to build the documentation, depends on ``scdoc``. Default: ON
100+
- SYSTEMD_USER_SERVICE=ON|OFF - whether to use systemd user service file, depends on ``systemd``. Default: ON
101+
- SYSTEMD_SYSTEM_SERVICE=ON|OFF - whether to use systemd system service file, depends on ``systemd``. Default: OFF
102+
- OPENRC=ON|OFF - whether to use openrc service file. Default: OFF (TBD)
103+
96104

97105
### Compile
98-
At least on Fedora 39, might require ``sudo dnf install -y scdoc`` to have acccess to the ``scdoc`` manpage generator.
99106

100107
mkdir build
101108
cd build
102109
cmake ..
103110
make -j `nproc`
104111

112+
If issues appears, check the build options, but try to install the dependecies:
113+
114+
Debian-based:
115+
116+
sudo apt install scdoc
117+
118+
RHEL-based:
105119

120+
sudo dnf install scdoc
106121
## Troubleshooting
107122
### Custom keyboard layouts
108123
Currently, ydotool does not recognize if the user is using a custom keyboard layout. In order to comfortably use ydotool alongside a custom keyboard layout, the user could use one of the following fixes/workarounds:

0 commit comments

Comments
 (0)