Merge pull request #168 from supercollider/docs

Updates to docs and packaging

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
 

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.

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/`.

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.

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\<USERNAME>\AppData\Local\SuperCollider\Extensions
+Default installation in userExtensionsDir:
+    C:\Users\<USERNAME>\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` (