Skip to content

Update README with required packages for Wayland #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README with required packages for Wayland #394

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a71458
Added required packages for wayland.
BinarSkugga Feb 29, 2024
8b3f8d8
better phrasing and added libdecor-devl for Gnome Wayland users
BinarSkugga Mar 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* GLFW C library source is included and built automatically as part of the Go package. But you need to make sure you have dependencies of GLFW:
* On macOS, you need Xcode or Command Line Tools for Xcode (`xcode-select --install`) for required headers and libraries.
* On Ubuntu/Debian-like Linux distributions, you need `libgl1-mesa-dev` and `xorg-dev` packages.
* On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel libXxf86vm-devel` packages.
* On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel libXxf86vm-devel` packages. If you develop with wayland, you need `libxkbcommon-devel wayland-devel mesa-libGL-devel`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems a bit unclear if this means "you only need" or "you also need". Since "mesa-libGL-devel" is repeated, I'm guessing it's not the latter?

It might be more clear to reuse the phrasing from below:

"On CentOS/Fedora-like Linux distributions, you need [...common packages...]. To build for X, also need [...extra packages for X...]; and to build for Wayland, you also need [...extra packages for Wayland...]."

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is also worth noting that libdecor-devel can be useful as an optional dependency for better titlebars.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay, work became hectic. Should be clearer !

* On FreeBSD, you need the package `pkgconf`. To build for X, you also need the package `xorg`; and to build for Wayland, you need the package `wayland`.
* On NetBSD, to build for X, you need the X11 sets installed. These are included in all graphical installs, and can be added to the system with `sysinst(8)` on non-graphical systems. Wayland support is incomplete, due to missing wscons support in upstream GLFW. To attempt to build for Wayland, you need to install the `wayland libepoll-shim` packages and set the environment variable `PKG_CONFIG_PATH=/usr/pkg/libdata/pkgconfig`.
* On OpenBSD, you need the X11 sets. These are installed by default, and can be added from the ramdisk kernel at any time.
Expand Down