From 699a74a733dade00d0f5180603668068d3deb261 Mon Sep 17 00:00:00 2001 From: Robert Oostenveld Date: Wed, 6 May 2015 09:32:27 +0200 Subject: [PATCH] Updated documentation --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5b95f5f1..19ae43e0 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,38 @@ # eegsynth-matlab -Converting real-time EEG into sounds and music +Converting real-time EEG into sounds and music. + +This repository contains the MATLAB code for the rapid application development of http://www.eegsynth.org. ## Platform specific notes for Microsoft Windows -Development is done on a VirtualBox with Windows 7 and MATLAB 2012b. +Development is done on a VirtualBox with Windows 7, MATLAB 2012b for 64 bit and MATLAB 2011b for 32 bit. -Precompiled mex file are provided, these are linked to a static version of portmidi. To +Precompiled mex file are provided, these are linked to a static version of portmidi. To use these mex files in MATLAB, you might have to install the Microsoft Visual C++ 2010 Redistributable Package, which is available from [1]. This package contains some additional system libraries that are used by MSVC 2010. Compiling the mex files from scratch requires that you have a C/C++ compiler installed. We have used (and only tested with) Microsoft Visual C++ Express 2010, which is available -from [2]. COmpiling 64-bit mex files furthermore requires that you have the Windows -Software Development Kit version 7.1 (see [3]). +from [2]. Compiling 64-bit mex files furthermore requires that you have the Windows +Software Development Kit version 7.1 [3]. -[1] https://www.microsoft.com/en-us/download/details.aspx?id=5555 -[2] https://www.visualstudio.com/en-us/downloads -[3] http://stackoverflow.com/questions/1865069/how-to-compile-a-64-bit-application-using-visual-c-2010-express +[1] https://www.microsoft.com/en-us/download/details.aspx?id=5555 +[2] https://www.visualstudio.com/en-us/downloads +[3] http://stackoverflow.com/questions/1865069/how-to-compile-a-64-bit-application-using-visual-c-2010-express ## Platform specific notes for Mac OS X Development is done on a MacBook Pro with OS X 10.9.5 and MATLAB 2012b. -Compilation of the mex files requires that portmidi is present. This can be downloaded -from http://portmedia.sourceforge.net/portmidi. Compilation of portmidi requires cmake. -It is also possible to install a compiled version of portmidi using MacPorts ("sudo port -install portmidi"). +Compilation of the mex files requires that portmidi [4] is present. To compile portmidi +you need cmake [5]. It is also possible to install a compiled version of portmidi using +MacPorts [6] with "sudo port install portmidi". Furthermore, for compilation you probably need to update the library path settings in compile\_midi.m +[4] http://portmedia.sourceforge.net/portmidi +[5] http://www.cmake.org +[6] https://www.macports.org + ## Platform specific notes for Linux Compilation on Linux requires the ALSA libraries to be installed.