Skip to content

Commit a57a784

Browse files
author
Wendy
committed
docs: Add macOS full build from source instructions
The existing macOS section only covers generating an Xcode project for frontend-sdl2, but omits the prerequisite step of building libprojectM from source. Pre-built macOS binaries are not published, leaving macOS users without a working path. This adds a self-contained walkthrough covering Homebrew deps, building libprojectM with CMAKE_INSTALL_PREFIX, and building frontend-sdl2 with CMAKE_PREFIX_PATH pointing at that install.
1 parent 86885be commit a57a784

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,3 +155,41 @@ mkdir cmake-build
155155
cmake -G Xcode -S . -B cmake-build -DCMAKE_CONFIGURATION_TYPES=Debug,Release
156156
cmake --build cmake-build --config Release
157157
```
158+
159+
#### macOS: Full build from source (including libprojectM)
160+
161+
Pre-built macOS binaries are not currently published. Use the following to build everything from source:
162+
163+
**Prerequisites**
164+
165+
```shell
166+
xcode-select --install
167+
brew install cmake sdl2 poco freetype git
168+
```
169+
170+
**1. Build and install libprojectM**
171+
172+
```shell
173+
git clone --recurse-submodules https://github.com/projectM-visualizer/projectm.git
174+
cmake -S projectm -B projectm/cmake-build \
175+
-DCMAKE_BUILD_TYPE=Release \
176+
-DCMAKE_INSTALL_PREFIX=~/dev/projectm-install \
177+
-DENABLE_EMSCRIPTEN=OFF
178+
cmake --build projectm/cmake-build --config Release --parallel $(sysctl -n hw.logicalcpu)
179+
cmake --install projectm/cmake-build
180+
```
181+
182+
**2. Build frontend-sdl2**
183+
184+
```shell
185+
git clone --recurse-submodules https://github.com/projectM-visualizer/frontend-sdl2.git
186+
cmake -S frontend-sdl2 -B frontend-sdl2/cmake-build \
187+
-DCMAKE_BUILD_TYPE=Release \
188+
-DCMAKE_PREFIX_PATH=~/dev/projectm-install \
189+
-DCMAKE_INSTALL_PREFIX=~/dev/projectm-install
190+
cmake --build frontend-sdl2/cmake-build --config Release --parallel $(sysctl -n hw.logicalcpu)
191+
cmake --install frontend-sdl2/cmake-build
192+
```
193+
194+
`projectM.app` will be in `~/dev/projectm-install/`. Edit
195+
`projectM.app/Contents/Resources/projectMSDL.properties` to set your preset and texture paths, then launch the app.

0 commit comments

Comments
 (0)