Skip to content
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

Add macOS build instructions and troubleshooting to README.md #98

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add macOS build instructions and troubleshooting to README.md #98

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
51 changes: 47 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,59 @@ Gapless (AKA: G4Music) is a light weight music player written in GTK4, focuses o
pkg install vala meson libadwaita gstreamer1-plugins-all gettext gtk4
```

## macOS Dependencies

### Install Homebrew

First, install Homebrew by running the following command in your terminal:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

### Install Required Packages

Once Homebrew is installed, install the necessary dependencies with:
```bash
brew install vala meson gobject-introspection libadwaita ninja gtk4 gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav desktop-file-utils
```

## How to build
It is written in Vala, simple and clean code, with few third-party dependencies:

1. Clone the code from gitlab.
2. Install vala, develop packages of gtk4, libadwaita, gstreamer.
3. Run in the project directory:
Gapless is written in Vala with clean and straightforward code, relying on minimal third-party dependencies. Follow these steps to build the application:

1. Clone the Repository:

`git clone https://github.com/neithern/g4music.git`

`cd g4music`

2. Install Dependencies: Ensure that Vala, GTK4 development packages, libadwaita, and GStreamer are installed on your system.
3. Build the Project: Run the following commands in the project directory:

`meson setup build --buildtype=release`

`meson install -C build`

## Change Log
Check the [release tags](https://gitlab.gnome.org/neithern/g4music/-/tags) for change log.

## Troubleshooting

### macOS Application Not Responding

If Gapless (G4Music) is not responding on macOS, you may need to set the GSK_RENDERER environment variable to use the OpenGL renderer. Follow these steps:

1. Set the Environment Variable: Open your terminal and add the following line:

```bash
# for g4music
export GSK_RENDERER="gl"
```

2. Rerun the Application: Start Gapless by running:

```bash
g4music
```

This should resolve issues related to the application not responding on macOS.