Add pandoc documentation generation and improve install configuration

- Add pandoc to CI workflows for all platforms (Linux, macOS, Windows)
- Generate manual.html during build (reTunerManual target)
- Fix macOS plugin install paths for CPack compatibility
- Switch macOS CPack generator from ZIP to DragNDrop (DMG)
- Improve README installation instructions with platform-specific guidance
- Simplify app install destination and remove redundant file installs

Author: mfisher31

.github/workflows/build.yml

@@ -30,6 +30,7 @@ jobs:
           build-essential \
           cmake \
           ninja-build \
+          pandoc \
           libasound2-dev \
           libjack-jackd2-dev \
           ladspa-sdk \
@@ -49,12 +50,12 @@ jobs:
     - name: Install dependencies (macOS)
       if: runner.os == 'macOS'
       run: |
-        brew install cmake ninja
-    
+        brew install cmake ninja pandoc
+
     - name: Install dependencies (Windows)
       if: runner.os == 'Windows'
       run: |
-        choco install cmake ninja -y
+        choco install cmake ninja pandoc -y
     
     - name: Setup MSVC environment (Windows)
       if: runner.os == 'Windows'

.github/workflows/release.yml

@@ -33,6 +33,7 @@ jobs:
           build-essential \
           cmake \
           ninja-build \
+          pandoc \
           libasound2-dev \
           libjack-jackd2-dev \
           ladspa-sdk \
@@ -52,12 +53,12 @@ jobs:
     - name: Install dependencies (macOS)
       if: runner.os == 'macOS'
       run: |
-        brew install cmake ninja
+        brew install cmake ninja pandoc
     
     - name: Install dependencies (Windows)
       if: runner.os == 'Windows'
       run: |
-        choco install cmake ninja -y
+        choco install cmake ninja pandoc -y
     
     - name: Setup MSVC environment (Windows)
       if: runner.os == 'Windows'

CMakeLists.txt

@@ -1,4 +1,3 @@
-
 cmake_minimum_required(VERSION 3.21)
 project(retuner VERSION 1.1.0)
 
@@ -129,20 +128,46 @@ if(LINUX OR WIN32)
     install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/reTuner_artefacts/$<CONFIG>/VST3/"
         DESTINATION "${CMAKE_INSTALL_LIBDIR}/vst3")
 elseif(APPLE)
-    install(TARGETS "reTuner_AU"   LIBRARY DESTINATION "Library/Audio/Plug-Ins/Components")
-    install(TARGETS "reTuner_CLAP" LIBRARY DESTINATION "Library/Audio/Plug-Ins/CLAP")
-    install(TARGETS "reTuner_VST3" LIBRARY DESTINATION "Library/Audio/Plug-Ins/VST3")
+    install(TARGETS "reTuner_AU"   LIBRARY DESTINATION "Plug-Ins/AU")
+    install(TARGETS "reTuner_CLAP" LIBRARY DESTINATION "Plug-Ins/CLAP")
+    install(TARGETS "reTuner_VST3" LIBRARY DESTINATION "Plug-Ins/VST3")
     # LV2 on macOS isn't a real library bundle.
     install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/reTuner_artefacts/$<CONFIG>/LV2/"
-        DESTINATION "Library/Audio/Plug-Ins/LV2")
+        DESTINATION "Plug-Ins/LV2")
+endif()
+
+find_program(PANDOC_EXECUTABLE pandoc)
+if(PANDOC_EXECUTABLE)
+    message(STATUS "Found pandoc: ${PANDOC_EXECUTABLE}")
+    
+    add_custom_target(reTunerManual ALL
+        COMMAND ${PANDOC_EXECUTABLE}
+            -o "${CMAKE_BINARY_DIR}/manual.html"
+            --standalone
+            "${CMAKE_SOURCE_DIR}/docs/manual.md"
+        COMMENT "Generating the manual with pandoc"
+        VERBATIM
+        BYPRODUCTS
+            "${CMAKE_BINARY_DIR}/manual.html"
+    )
+    if(LINUX)
+        install(FILES "${CMAKE_BINARY_DIR}/manual.html"
+            DESTINATION "${CMAKE_INSTALL_DATADIR}/retuner")
+    else()
+        install(FILES "${CMAKE_BINARY_DIR}/manual.html"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}")
+    endif()
+else()
+    message(STATUS "pandoc not found - documentation target will not be available")
 endif()
 
 add_subdirectory(src/app)
 add_subdirectory(test)
 
 if(LINUX)
-    install(FILES README.md LICENSE.txt docs/manual.md 
-        DESTINATION "${CMAKE_INSTALL_DATADIR}/retuner")
+    install(FILES LICENSE.txt DESTINATION "${CMAKE_INSTALL_DATADIR}/retuner")
+else()
+    install(FILES LICENSE.txt DESTINATION "${CMAKE_INSTALL_PREFIX}")
 endif()
 
 # CPack configuration
@@ -162,30 +187,25 @@ set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE.txt")
 if(LINUX)
     set(RETUNER_SYSTEM_NAME "linux")
     string(TOLOWER "${CMAKE_SYSTEM_PROCESSOR}" RETUNER_PROCESSOR)
-    set(CPACK_GENERATOR "TGZ;DEB")
+    set(CPACK_GENERATOR "DEB")
     set(CPACK_ARCHIVE_COMPONENT_INSTALL OFF)
     set(CPACK_PACKAGING_INSTALL_PREFIX "/usr")
     set(CPACK_DEBIAN_PACKAGE_DEPENDS "libasound2;libfreetype6;libx11-6;libxext6;libxrandr2;libxinerama1;libxcursor1;libcurl4;libgl1;libstdc++6")
 elseif(APPLE)
     set(RETUNER_SYSTEM_NAME "macos")
     set(RETUNER_PROCESSOR "universal")
-    set(CPACK_GENERATOR "ZIP")
+    set(CPACK_GENERATOR "DragNDrop")
     set(CPACK_ARCHIVE_COMPONENT_INSTALL OFF)
-    set(CPACK_SET_DESTDIR OFF)
+    set(CPACK_SET_DESTDIR ON)
     set(CPACK_PACKAGING_INSTALL_PREFIX "/")
-    install(FILES README.md LICENSE.txt docs/manual.md 
-        DESTINATION "${CMAKE_INSTALL_PREFIX}")
 elseif(WIN32)
     set(RETUNER_SYSTEM_NAME "windows")
     string(TOLOWER "${CMAKE_SYSTEM_PROCESSOR}" RETUNER_PROCESSOR)
     set(CPACK_IGNORE_FILES ".*\\.lib$;.*\\.exp$;.*\\.ico$")
     set(CPACK_GENERATOR "ZIP")
     set(CPACK_ARCHIVE_COMPONENT_INSTALL OFF)
     set(CPACK_PACKAGING_INSTALL_PREFIX "/")
-    install(FILES README.md LICENSE.txt docs/manual.md 
-        DESTINATION "${CMAKE_INSTALL_PREFIX}")
 endif()
 
 set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${CPACK_PACKAGE_VERSION}-${RETUNER_SYSTEM_NAME}-${RETUNER_PROCESSOR}")
 include(CPack)
-

README.md

@@ -4,7 +4,7 @@ reTuner is a precision audio pitch shifting plugin designed to convert music bet
 
 ![Screenshot](docs/screenshot.png)
 
-Built with [JUCE](https://juce.com/) and [Rubber Band Library](https://breakfastquay.com/rubberband/).
+Built with [JUCE](https://juce.com/) and [Rubber Band](https://breakfastquay.com/rubberband/).
 
 ## Features
 
@@ -56,8 +56,21 @@ git submodule update --init --recursive
     ```
 
 ## Installation
+### Linux
+Note: You might need `sudo` depending on your prefix:
+```sh
+cmake --install build
+```
+
+### Mac an PC
+**WARNING** 
+_Do not_ use `cmake --install ...` to install apps and plugins on these platforms.  cmake install for these platforms is set up to work well with cpack, not system installation.  Use at your own peril.
+
+**INSTEAD** 
+After building, the artifacts can be found in the `build/reTuner_artefacts` directory for plugins and `build/src/app/reTunerApp_artefacts` for the standalone application. Just manually copy them where you want them.
 
-After building, the artifacts can be found in the `reTuner_artefacts` directory for plugins or `build/reTunerApp_artefacts` for the standalone application.
+**OR**
+You can use JUCE's [copy plugin options in cmake](deps/JUCE/docs/CMake%20API.md). Search for `COPY_PLUGIN_AFTER_BUILD` in the JUCE docs for details. Note that this option won't copy the standalone application (`reTuner.app` or `reTuner.exe`), and may fail on Windows when copying to system directories.
 
 ## License
 

src/app/CMakeLists.txt

@@ -70,6 +70,5 @@ if(NOT APPLE)
     install(TARGETS reTunerApp DESTINATION ${CMAKE_INSTALL_BINDIR})
 else()
     install(TARGETS reTunerApp
-        BUNDLE DESTINATION "Applications"
-        COMPONENT "Standalone")
+        BUNDLE DESTINATION "${CMAKE_INSTALL_PREFIX}")
 endif()