From b5f96f0a058d506b749d4b6bef2587e2f4db97f0 Mon Sep 17 00:00:00 2001 From: Brian Heim Date: Sun, 29 Oct 2017 11:21:13 -0400 Subject: [PATCH 1/3] Update instructions in readme to be more cross-platform friendly --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 492ddc33cc..c5b0dacb8f 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,9 @@ replace `/path/to/sc/` with the path to the SuperCollider source directory. That ```shell mkdir build && cd build cmake -DSC_PATH=/path/to/sc/ .. -make -make install +cmake --build . --config Release +# to install the plugins +cmake --build . --config Release --target install ``` If no `SC_PATH` is provided the build system assumes the SuperCollider include files are in `/usr/include/SuperCollider/`. From 6324830e6e693be8ea2a159a237f2b6108eb65f8 Mon Sep 17 00:00:00 2001 From: Brian Heim Date: Sun, 29 Oct 2017 11:21:42 -0400 Subject: [PATCH 2/3] Add cmake-configured readme for macOS --- CMakeLists.txt | 18 +++++++++++++++--- README_MACOS.txt.in | 19 +++++++++++++++++++ README_WINDOWS.txt.in | 11 +++++++---- 3 files changed, 41 insertions(+), 7 deletions(-) create mode 100644 README_MACOS.txt.in diff --git a/CMakeLists.txt b/CMakeLists.txt index 4b0dcaf0af..4ecbd00c3a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -135,11 +135,23 @@ if (OSX_PACKAGE) add_subdirectory(osx_package) endif() -if(WIN32) - configure_file( README_WINDOWS.txt.in README_WINDOWS.txt) - install( FILES "${CMAKE_CURRENT_BINARY_DIR}/README_WINDOWS.txt" DESTINATION . RENAME README.txt ) +# Configure readme file +if (WIN32 OR APPLE) + if (WIN32) + set(README_FILENAME README_WINDOWS.txt) + elseif(APPLE) + set(README_FILENAME README_MACOS.txt) + else() + unset(README_FILENAME) + endif() endif() +if (DEFINED README_FILENAME) + configure_file( "${README_FILENAME}.in" "${README_FILENAME}" ) + install( FILES "${CMAKE_CURRENT_BINARY_DIR}/${README_FILENAME}" DESTINATION . RENAME README.txt ) +endif() + + ############################################# # CPack support diff --git a/README_MACOS.txt.in b/README_MACOS.txt.in new file mode 100644 index 0000000000..6e9fcb6582 --- /dev/null +++ b/README_MACOS.txt.in @@ -0,0 +1,19 @@ +------------------------------------------------------------------------ +Supercollider ${PROJECT_VERSION} Plugins for macOS +------------------------------------------------------------------------ + +Before installation, please uninstall any previous version of the +plugins from your system. + +To install the plugins, place the SC3plugins folder into one of the +SuperCollider extension folders listed below, depending on your +operating system and installation type: + +Default installation in `Platform.userExtensionDir`: + ~/Library/Application Support/SuperCollider/Extensions + +System-wide installation in `Platform.systemExtensionDir`: + /Library/Application Support/SuperCollider/Extensions + +You can verify these locations by executing the corresponding command +from within SuperCollider. diff --git a/README_WINDOWS.txt.in b/README_WINDOWS.txt.in index e3670a98ac..8599c2939f 100644 --- a/README_WINDOWS.txt.in +++ b/README_WINDOWS.txt.in @@ -9,11 +9,14 @@ To install the plugins, place the SC3plugins folder into one of the SuperCollider extension folders listed below, depending on your operating system and installation type: -- Default installation in userExtensionsDir: - C:\Users\\AppData\Local\SuperCollider\Extensions +Default installation in userExtensionsDir: + C:\Users\\AppData\Local\SuperCollider\Extensions -- System-wide installation: - C:\ProgramData\SuperCollider\Extensions +System-wide installation: + C:\ProgramData\SuperCollider\Extensions + +You can verify these locations by executing the corresponding command +from within SuperCollider. *Note* for 32-bit version with supernova plugins: the bundle is split into two folders, `plugins` (containing the binary plugins) and `SC3plugins` ( From 3ab6a6db349e9906e201031fd8718cd88efd2b64 Mon Sep 17 00:00:00 2001 From: Brian Heim Date: Sun, 29 Oct 2017 11:21:57 -0400 Subject: [PATCH 3/3] Add DEVELOPING.md --- DEVELOPING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 DEVELOPING.md diff --git a/DEVELOPING.md b/DEVELOPING.md new file mode 100644 index 0000000000..ab14a4e57f --- /dev/null +++ b/DEVELOPING.md @@ -0,0 +1,27 @@ +sc3-plugins: Information for Developers +======================================= + +## Building on Windows + +This is doable (with VS 2013), but you will have to manually set the CMake variables +`FFTW3_INCLUDE_DIR` and `FFTW3F_LIBRARY` to the directory of FFTW3 and the lib file created while +building SuperCollider. See the SuperCollider repo's `README_WINDOWS.md` file for instructions +related to that. + +## Packaging / Releasing + +### Release + +When a release is made, a binary is automatically uploaded for macOS, but will need to be renamed. + +### Windows packaging + +Build the `package` target to generate a zip file. + +### macOS packaging + +Build the `package` target to generate a tarball. + +Another (legacy) option is to set `-DOSX_PACKAGE=ON` when configuring cmake, and then building the +`install` target. This will generate a `dmg`. There is no real benefit to using this, and it may be +removed in future versions of this software.