Strawberry Music Player

https://github.com/strawberrymusicplayer/strawberry
Admin
Strawberry is a music player and organizer, forked from Clementine in 2018, aimed at music...
Tokens:152,448
Snippets:1,093
Trust Score:7.3
License:GPL-3.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Build and install Strawberry with CMake

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/README.md

Configures, builds, and installs Strawberry using CMake. The build uses all available CPU cores via $(nproc).

```bash
cd strawberry
cmake -S . -B build
cmake --build build --parallel $(nproc)
sudo cmake --install build
```

--------------------------------

### Standard CMake Build Commands

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CLAUDE.md

Configure, build, and install Strawberry using CMake. Use a fresh build directory for command-line work; Qt Creator configs exist under build/Qt_Sys-*.

```bash
# Configure + build (standard)
cmake -S . -B build
cmake --build build --parallel $(nproc)
sudo cmake --install build
```

--------------------------------

### Run a Single Test Binary

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CLAUDE.md

Build a specific test target and run its binary directly. Example shows the utilities_test target and its binary path.

```bash
# Run a single test: build its target, then run the binary directly
cmake --build build --target utilities_test
./build/tests/utilities_test
```

--------------------------------

### Setup the remote

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CONTRIBUTING.md

Adds the upstream Strawberry repository as a remote so you can fetch changes from the original project.

```shell
git remote add upstream git@github.com:strawberrymusicplayer/strawberry.git
```

--------------------------------

### Build and Run All Tests

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CLAUDE.md

Build all test binaries with the build_tests target, then run them via ctest. Tests are EXCLUDE_FROM_ALL, so they must be built explicitly.

```bash
cmake --build build --target build_tests        # build all test binaries
cd build && ctest -V                            # run all tests
cmake --build build --target run_strawberry_tests   # build + run via ctest
```

--------------------------------

### Clone the repository

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CONTRIBUTING.md

Clones the forked Strawberry repository and changes into its directory. Replace "username" with your own GitHub username.

```shell
git clone git@github.com:username/strawberry.git
cd strawberry
```

--------------------------------

### Define add_test_file macro to create test targets

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/tests/CMakeLists.txt

Macro that creates an executable from a test source file, links required libraries (Qt, GLib, GStreamer, etc.), and registers it with CTest. It also adds a post-build command to run the test and adds a dependency on the build_tests target.

```cmake
macro(add_test_file test_source gui_required)
    get_filename_component(TEST_NAME ${test_source} NAME_WE)
    add_executable(${TEST_NAME} EXCLUDE_FROM_ALL ${test_source})
    target_include_directories(${TEST_NAME} PRIVATE
      ${CMAKE_BINARY_DIR}/src
      ${CMAKE_SOURCE_DIR}/src
    )
    target_link_libraries(${TEST_NAME} PRIVATE
      ${CMAKE_THREAD_LIBS_INIT}
      PkgConfig::GLIB
      PkgConfig::GOBJECT
      PkgConfig::GSTREAMER_BASE
      PkgConfig::GSTREAMER_APP
      Qt${QT_VERSION_MAJOR}::Core
      Qt${QT_VERSION_MAJOR}::Concurrent
      Qt${QT_VERSION_MAJOR}::Network
      Qt${QT_VERSION_MAJOR}::Sql
      Qt${QT_VERSION_MAJOR}::Test
      Qt${QT_VERSION_MAJOR}::Widgets
    )
    target_link_libraries(${TEST_NAME} PRIVATE test_utils)
    set(GUI_REQUIRED ${gui_required})
    if(GUI_REQUIRED)
      target_link_libraries(${TEST_NAME} PRIVATE test_gui_main)
    else()
      target_link_libraries(${TEST_NAME} PRIVATE test_main)
    endif()

    add_test(NAME ${TEST_NAME} COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${TEST_NAME}${CMAKE_EXECUTABLE_SUFFIX})
    add_custom_command(TARGET strawberry_tests POST_BUILD COMMAND ./${TEST_NAME}${CMAKE_EXECUTABLE_SUFFIX})
    add_dependencies(build_tests ${TEST_NAME})
endmacro(add_test_file)
```

--------------------------------

### Clone Strawberry repository with submodules

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/README.md

Clones the Strawberry source code including submodules using the --recursive flag.

```bash
git clone --recursive https://github.com/strawberrymusicplayer/strawberry
```

--------------------------------

### Register test files with add_test_file

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/tests/CMakeLists.txt

Calls the `add_test_file` macro for each test source file. The second argument indicates whether the test requires a GUI (true) or not (false). Waveform tests are conditionally added only when `HAVE_WAVEFORM` is defined.

```cmake
add_test_file(src/utilities_test.cpp false)
add_test_file(src/concurrentrun_test.cpp false)
add_test_file(src/mergedproxymodel_test.cpp false)
add_test_file(src/sqlite_test.cpp false)
add_test_file(src/tagreader_test.cpp false)
add_test_file(src/collectionbackend_test.cpp false)
add_test_file(src/collectionmodel_test.cpp true)
add_test_file(src/songplaylistitem_test.cpp false)
add_test_file(src/m3uparser_test.cpp false)
add_test_file(src/filterparser_test.cpp false)
add_test_file(src/plsparser_test.cpp false)
add_test_file(src/organizeformat_test.cpp false)
add_test_file(src/smartplaylistsearch_test.cpp false)
add_test_file(src/playlist_test.cpp true)
if(HAVE_WAVEFORM)
  add_test_file(src/waveformbuilder_test.cpp false)
  add_test_file(src/waveformpipeline_test.cpp false)
  add_test_file(src/waveformloader_test.cpp false)
  add_test_file(src/waveformcontroller_test.cpp false)
  add_test_file(src/waveformrenderer_test.cpp true)
  add_test_file(src/waveformproxystyle_test.cpp true)
endif()
```

--------------------------------

### Create a new branch

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CONTRIBUTING.md

Creates a new branch from the master branch for specific changes.

```shell
git checkout -b your-branch
```

--------------------------------

### Define run_strawberry_tests custom target

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/tests/CMakeLists.txt

Creates a custom target `run_strawberry_tests` that runs CTest with verbose output, depending on the `strawberry_tests` target.

```cmake
add_custom_target(run_strawberry_tests COMMAND ${CMAKE_CTEST_COMMAND} -V DEPENDS strawberry_tests)
```

--------------------------------

### Commit changes

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CONTRIBUTING.md

Commits the staged changes.

```shell
git commit
```

--------------------------------

### Stage changes

Source: https://github.com/strawberrymusicplayer/strawberry/blob/master/CONTRIBUTING.md

Stages changes for a specific commit. Keep commits relevant to the pull request and as small as possible.

```shell
git add -p
```
Tokens:
Raw