Skip to content

docs: Add minimal build guide for Ubuntu 24.04 (Wayland) #569

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 1 commit into
base: master
Choose a base branch
from
Open

docs: Add minimal build guide for Ubuntu 24.04 (Wayland) #569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,23 @@ back to using `softbuffer` and `tiny-skia`.

Custom color schemes can be imported from the `View -> Color schemes...` menu item.
You can find templates for color schemes in the [color-schemes](color-schemes) folder.

## Build on Ubuntu 24.04 LTS (Wayland) Minimal Dependencies

After extensive testing, the minimal set of dependencies required to build `cosmic-term` on Ubuntu 24.04 (Wayland) is as follows:

1. **Install Minimal Dependencies:**
```bash
sudo apt install libxkbcommon-dev libwayland-dev pkg-config libgl-dev libegl1-mesa-dev
```

2. **Set PKG_CONFIG_PATH:**
The build requires the `PKG_CONFIG_PATH` to be explicitly set to resolve the `xkbcommon.pc` dependency. This step must be run in the terminal session before executing `cargo run`.
```bash
export PKG_CONFIG_PATH=/usr/lib/x86_64-linux-gnu/pkgconfig:/usr/share/pkgconfig
```

3. **Build and Run:**
```bash
cargo run --release
```