1 files changed, 62 insertions, 0 deletions
diff --git a/mayaPlug/README-samples.osx b/mayaPlug/README-samples.osx
new file mode 100644
index 0000000..678e60e
--- /dev/null
+++ b/mayaPlug/README-samples.osx
@@ -0,0 +1,62 @@
+Shave And A Haircut APIs
+------------------------
+There are two APIs for use with Shave: a standalone API for building
+applications which process Shave archive files (such as those produced by
+the 'shaveRender -createDRAFile' command in Maya), and a plugin API for
+building Maya plugins which can access Shave's data from within Maya.
+
+
+Standalone API
+--------------
+The standalone API consists of the following two header files, found in this
+directory:
+
+  shaveEngine.h
+  shaveSDKTYPES.h
+
+as well as the following dynamic library, also found in this directory:
+
+  libShaveEngine.dylib
+
+
+Maya Plugin API
+---------------
+The Maya plugin API consists of the following two header files, found in the
+same directory as Maya's own API header files
+(e.g.  /Applications/Alias/maya7.0/devkit/include/maya):
+
+  shaveAPI.h
+  shaveItHair.h
+
+as well as the following dynamic libraries, found in Maya's shared 'plug-ins'
+directory (e.g. /Users/Shared/Alias/maya/7.0/plug-ins):
+
+  libShave.dylib
+  libShaveAPI.dylib
+
+The header files contain complete documentation on the plugin API.
+
+
+Sample Code
+-----------
+'shaveAPITestCmd.cpp' is a sample Maya plugin using Shave's plugin API.
+
+'shaveAPITestApp.cpp' is a sample application using Shave's standalone API.
+
+To build them, set your MAYA_LOCATION environment variable to point to the
+Maya.app/Contents directory for the version of Maya you plan on using the
+plugin with.  E.g:
+
+  setenv MAYA_LOCATION /Applications/Alias/maya7.0/Maya.app/Contents
+
+Then execute the following command:
+
+  make
+
+To execute a standalone application, either run the application from the
+same directory which contains the libShaveEngine.dylib file, or else
+set the DYLD_LIBRARY_PATH environment variable to point to that directory.
+E.g:
+
+  setenv DYLD_LIBRARY_PATH /Users/Shared/Epic Games/shaveHaircut/maya2017/samples
+