Merge pull request #87 from mpsonntag/readme

Readme, build notes and license

Author: asobolev

LICENSE.txt

@@ -0,0 +1,31 @@
+Copyright (c) 2015, German Neuroinformatics Node (G-Node)
+                    Christian Kellner ([email protected])
+                    Andrey Sobolev ([email protected])
+                    Michael Sonntag ([email protected])
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software
+   must display the following acknowledgement:
+   This product includes software developed by the G-Node.
+4. Neither the name of the G-Node nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY G-NODE ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL G-NODE BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,20 @@
+About NIX-MX
+-------------
+
+The *NIX-MX* project is an extension to [NIX](https://github.com/G-Node/nix) and provides Matlab bindings for *NIX*.
+
+
+Development Status
+------------------
+
+The *NIX-MX* project has been developed and tested solely under Windows 32 and Windows 64 and is in an alpha stage of development. In detail all of the features of NIX have been implemented and unit tests for all of the methods exist and pass, but extensive testing and some refactoring of existing code has to be done as of yet.
+
+
+Getting Started (Windows 32/64)
+-------------------------
+
+As of now there is no Windows installer for NIX-MX.
+
+**Build NIX-MX under Windows**
+
+To build NIX-MX under windows please follow the guide provided at [WinBuild.md](https://github.com/G-Node/nix-mx/WinBuild.md)

WinBuild.md

@@ -0,0 +1,84 @@
+How to build NIX-MX on Windows
+------------------------------
+
+Follow these steps to set up the development environment for the NIX Matlab bindings under Windows32/64 for Matlab 32bit
+
+**Dependencies**
+- download and install Visual Studio 12
+- make sure you have a fork of [NIX](https://github.com/G-Node/nix) and [NIX-MX](https://github.com/G-Node/nix-mx)
+- get the latest [NIX Windows dependencies](https://projects.g-node.org/nix/), extract to [your path]\nix-dep\
+
+**Build process for DEBUG build**
+- start cmd (NOT powershell!), move to [your path]\nix; create "build" directory, move inside
+- to set up dependencies path variables for NIX cmake, run:
+	`[your path]\nix-dep\nixenv.bat`
+- if working on a 32bit Windows, run:
+	`cmake .. -G "Visual Studio 12"`
+- if working on a 64bit Windows, run:
+	`set PLATFORM=x64`
+	`cmake .. -G "Visual Studio 12 Win64"`
+- with Visual Studio open [your path]\nix\build\nix.sln
+
+    NOTE! Visual Studio builds by default with configuration "Debug" and "32bit"! If some other build is required, set BUILD->ConfigurationManager->Active solution configuration!
+- Build "ALL_BUILD"
+- within the cmd shell move to [your path]\nix\build\Debug
+- run again
+	`[your path]\nix-dep\nixenv.bat`
+- run
+	`[your path]\nix\build\Debug\TestRunner.exe`
+- within the cmd shell move to [your path]\nix-mx, create and move into "build" folder
+- set the NIX root path;
+	`set NIX_ROOT=[your path]/nix`
+
+    IMPORTANT:
+    - do not use quotes in cmd!
+    - do not use backslashes, only slashes! e.g. c:/work/nix; c:\work\nix will not work!
+
+- run again
+	`[your path]\nix-dep\nixenv.bat`
+- check, if the nix.dll library has been created in [your path]\nix\build\Debug
+- if yes, open [your path]\nix-mx\cmake\FindNIX.cmake
+- add "HINTS $ENV{NIX_ROOT}/build/Debug" to the "find_library(NIX_LIBRARY NAMES" statement
+- if working on Windows 32bit, run
+	`cmake .. -G "Visual Studio 12"`
+- if working on Windows 64bit, run
+	`cmake .. -G "Visual Studio 12 Win64"`
+- with Visual Studio open [your path]\nix-mx\build\nix-mx.sln
+- Build "ALL_BUILD"
+- copy all of the following files into the [your path]\nix-mx\build folder; simply providing the directories to MatLab using "addpath" does not work
+
+	from [your path]\nix-dep\[x86/x64]\hdf5-1.8.14\bin (path dependent on the Windows 32/64 bit version)
+	
+		`hdf5.dll, msvcp120.dll, msvcr120.dll, szip.dll, zlib.dll`
+		
+	from [your path]\nix\build\Debug
+	
+		`nix.dll`
+		
+	from [your path]\nix-mx\build\Debug
+	
+		`nix_mx.mexw32 or nix_mx.mexw64`
+		
+- get some NIX files from the [your path]\nix\build\ test folder and NIX away!
+
+
+**Alternate build process for RELEASE build**
+
+The build described above is for DEBUG which prevents the usage of msvcp120.dll and msvcr120.dll and requires the usage of msvcp120d.dll and msvcr120d.dll
+
+To use the correct dlls, nix and nix-mx have to be built in RELEASE mode! For this:
+- replace "Debug" with "Release" in the nixenv.bat, use this to setup environmental variables
+- run cmake
+- open sln, in Visual Studio set BUILD->ConfigurationManager->Active solution configuration to "Release" instead of "Debug"
+- re-run TestRunner.exe in folder "Release" instead of "Debug"
+- move to the [your path]\nix-mx\build folder
+- re-run the modified nixenv.bat
+- run
+
+	`$env:NIX_ROOT="c:/work/nix"`
+- open [your path]\nix-mx\cmake\FindNIX.cmake and add
+
+	"HINTS $ENV{NIX_ROOT}/build/Release" to the "find_library(NIX_LIBRARY NAMES" statement
+- run cmake
+- open sln, in Visual Studio set BUILD->ConfigurationManager->Active solution configuration to "Release" instead of "Debug"
+- setup the rest like in debug mode