updating text files to provide minimum documentation

License.md

@@ -1,4 +1,15 @@
-The software to which this license pertains is the Max API that consists of the C/C++ language header files and source code examples contained within this archive.
+## VBAP
+
+The original VBAP source code and documentation were authored by [Ville Pullki](https://people.aalto.fi/index.html#ville_pulkki). Permission was granted to [Nathan Wolek](https://github.com/nwolek) to adapt and update this code so that it would work with 64-bit versions of [Max](https://cycling74.com/products/max). 
+
+Copyright © 1998-2007, Ville Pullki.  
+Copyright © 2017, Nathan Wolek. 
+
+All of this work is licensed under terms of CC-BY-SA: [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+## Max API
+
+The software to which this license pertains is the Max API that consists of the C/C++ language header files and source code examples contained within the [max-devkit archive](https://github.com/Cycling74/max-devkit).
 
 The MIT License
 

ReadMe.md

@@ -1,91 +1,6 @@
-# Max-DevKit
+# VBAP package for Max
 [![Build Status](https://travis-ci.org/Cycling74/max-devkit.svg?branch=master)](https://travis-ci.org/Cycling74/max-devkit)
 [![Build status](https://ci.appveyor.com/api/projects/status/4u6n0eseaemdp2t5?svg=true)](https://ci.appveyor.com/project/tap/max-devkit)
 
 
-Tools, documentation, and reference implementation of a Max Package built using the Max-API.
-
-For full backwards compatibility or additional functionality, the [legacy Max SDK](https://github.com/Cycling74/max-sdk) may provide an alternate path for those wishing to create their own package including Max external objects written in C/C++.
-
-## Structure
-
-There are two levels of material included in the Max-DevKit package.  The outer level is a Max package folder named, appropriately, "max-devkit".  The inner level is a folder called "max-api". 
-
-* `max-devkit` is an example package following current best-practices package creation.
-* `max-api` is a folder containing all of the support files you will need to compile an external object written in C/C++.  This folder you will include in your own package's source folder.
-
-
-## Prerequisites
-
-To build the externals in this package you will need some form of compiler support on your system. 
-
-* On the Mac this means Xcode (you can get from the App Store for free). 
-* On Windows this most likely means some version of Visual Studio (the free versions should work fine).
-
-You will also need to install [CMake](https://cmake.org/download/).
-
-
-## Building
-
-0. Get the code from Github, or download a zip and unpack it into a folder.
-1. In the Terminal or Console app of your choice, change directories (cd) into the folder you created in step 0.
-2. `mkdir build` to create a folder with your various build files
-3. `cd build` to put yourself into that folder
-4. Now you can generate the projects for your choosen build environment:
-
-### Mac 
-
-You can build on the command line using Makefiles, or you can generate an Xcode project and use the GUI to build.
-
-* Xcode: Run `cmake -G Xcode ..` and then run `cmake --build .` or open the Xcode project from this "build" folder and use the GUI.
-* Make: Run `cmake ..` and then run `cmake --build .` or `make`.  Note that the Xcode project is preferrable because it is able substitute values for e.g. the Info.plist files in your builds.
-
-### Windows
-
-The exact command line you use will depend on what version of Visual Studio you have installed.  You can run `cmake --help` to get a list of the options available.  Assuming some version of Visual Studio 2013, the commands to generate the projects will look like this:
-
-* 32 bit: `cmake -G "Visual Studio 12" ..`
-* 64 bit: `cmake -G "Visual Studio 12 Win64" -DWIN64:Bool=True ..`
-
-Having generated the projects, you can now build by opening the .sln file in the build folder with the Visual Studio app (just double-click the .sln file) or you can build on the command line like this:
-
-`cmake --build . --config Release`
-
-
-## Testing
-
-It is highly recommended that you test your code thoroughly. One option is use the [max-test](https://github.com/Cycling74/max-test) package.
-
-## Continuous Integration
-
-Continuous Integration (CI) is...
-
-The Max-DevKit project models CI using two different services, both of which are free and very easy to set up if your project is hosted publically on Github.
-
-* **Mac**: go to http://travis-ci.org and sign up.  If your repository follows the same model as Max-DevKit, you can copy `.travis.yml` directly with no changes.  Now every push to your repository will trigger an automatic build for the Mac with Travis CI.
-* **Windows**: go to http://appveyor.com and sign up.  If your repository follows the same model as Max-DevKit, you can copy `appveyor.yml` directly with no changes.  Now every push to your repository will trigger automatic builds for both 32 and 64-bit Windows with Appveyor.
-
-### Fetching your builds
-
-* **Windows**: On Appveyor it is simple.  You go to the latest build, choose the "Platform" and then look under the "Artifacts" tab.
-* **Mac**: Travis CI does not host your build files for you like Appveyor. Instead, you need to configure a place for Travis to upload your builds. This is most easily done by signing up for a [free Amazon Web Services account](http://aws.amazon.com/free/).
-
-#### S3 Integration
-
-The builds from Travis for this package can be found on [this S3-hosted page](https://s3-us-west-2.amazonaws.com/cycling74-ci/index.html?prefix=max-devkit/).
-
-To setup your own page:
-
-0. Sign up for a free AWS account as mentioned above
-1. Create a "bucket" for your Travis builds
-2. Add the correct info to your `.travis.yml` file for your S3 bucket as described in the [Travis S3 Documentation](https://docs.travis-ci.com/user/deployment/s3).
-3. At this point, builds should go from Travis to a folder in your S3 bucket.
-4. To access the build, you can log in to your S3 account and download it. Alternatively you may want to make your builds publically available. If you wish to do the later, read on...
-5. upload the files from this folder's `source/max-api/site` folder to your S3 bucket's root folder. For more information on the content of these files, please visit the Github page for the [S3 Bucket Listing Code](https://github.com/rgrp/s3-bucket-listing).
-6. As described on the above Github page, you will need to set the permissions for your bucket such that "Everyone" has both `listing` and `viewing` access.
-
-
-## Support
-
-For support, please use the developer forums at:
-http://cycling74.com/forums/
+Legacy objects for Vector Based Amplitude Panning in Max authored by [Ville Pullki](https://people.aalto.fi/index.html#ville_pulkki) and adapted by [Nathan Wolek](https://github.com/nwolek).

package-info.json.in

@@ -1,9 +1,9 @@
 {
-	"author" : "Cycling '74",
-	"description" : "Lightweight reference implementation of a package built around the core Max-API.",
-	"homepatcher" : "max-devkit.maxpat",
+	"author" : "Nathan Wolek",
+	"description" : "Legacy objects for Vector Based Amplitude Panning in Max.",
+	"homepatcher" : "vbap.maxhelp",
 	"max_version_min" : "7.1",
-	"name" : "max-devkit",
+	"name" : "VBAP",
 	"os" : {
 		"macintosh" : {
 			"platform" : [ "ia32", "x64" ],
@@ -15,10 +15,10 @@
 		}
 	},
 	"package_extra" : { 
-		"reverse_domain" : "com.cycling74",
-		"copyright" : "Copyright (c) 2016 Cycling '74"
+		"reverse_domain" : "com.nathanwolek",
+		"copyright" : "Copyright © 2017, Nathan Wolek. CC-BY-SA."
 	},
-	"tags" : [ ],
+	"tags" : [ "surround", "multichannel" ],
 	"version" : "@GIT_VERSION_MAJ@.@GIT_VERSION_MIN@.@GIT_VERSION_SUB@",
-	"website" : "http://www.github.com/Cycling74/max-devkit"
+	"website" : "http://www.github.com/nwolek"
 }