Skip to content

Commit c96f287

Browse files
committed
[README] update readme file
1 parent 5443662 commit c96f287

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,62 @@
11
About NIX-MX
22
-------------
33

4-
The *NIX-MX* project is an extension to [NIX](https://github.com/G-Node/nix) and provides Matlab bindings for *NIX*.
4+
The *NIX-MX* project is an extension to [NIX](https://github.com/G-Node/nix) and provides
5+
Matlab bindings for *NIX*.
56

67

78
Development Status
89
------------------
910

10-
The *NIX-MX* project has been developed and tested under Windows 32 and Windows 64 and can easily be built under MacOS. Specifically all of the features of NIX v1.4.0 have been implemented and tests for all of the methods exist and pass.
11+
The *NIX-MX* project has been developed and tested under Windows 32 and Windows 64 and can
12+
easily be built under MacOS. Specifically all of the features of NIX v1.4.1 have been
13+
implemented and tests for all of the methods exist and pass.
1114

1215

1316
Getting Started (Windows 32/64)
1417
-------------------------------
1518

16-
**Quick start packages, Release 1.4.0**
19+
**Quick start packages, Release 1.4.1**
1720

18-
The [quick start packages](https://github.com/G-Node/nix-mx/releases) are compiled under Windows 32/64 and contain all dlls, binary and Matlab files required to use NIX-MX with the respective Windows OS.
19-
The included *NIX* dll is a [stable release 1.4.0 build](https://github.com/G-Node/nix/releases/tag/1.4.0). To use the packages, unzip them into a folder of your choice and run the `startup.m` script from the root folder. Do not change the file/folder structure.
21+
The [quick start packages](https://github.com/G-Node/nix-mx/releases) are compiled under
22+
Windows 32/64 and contain all binary and Matlab files required to use NIX-MX with
23+
the respective Windows OS.
24+
The included *NIX* library is a [stable release 1.4.1 build](https://github.com/G-Node/nix/releases/tag/1.4.1).
25+
To use the packages, unzip them into a folder of your choice and run the `startup.m`
26+
script from the root folder. Do not change the file/folder structure.
2027

2128
The Windows 64 package contains:
22-
- HDF5 dlls (Release 1.8.14)
23-
- NIX dll (stable release 1.4.0 build, compiled using BOOST 1.57.0 and CPPUNIT 1.13.2)
24-
- NIX-MX (Release 1.4.0, 19.09.2017)
29+
- NIX library (stable release 1.4.1 build, compiled using BOOST 1.57.0, CPPUNIT 1.13.2 and HDF 1.10.1)
30+
- NIX-MX (Release 1.4.1)
2531

2632
The Windows 32 package contains:
27-
- HDF5 dlls (Release 1.8.14)
28-
- NIX dll (stable release 1.4.0 build, compiled using BOOST 1.57.0 and CPPUNIT 1.13.2)
29-
- NIX-MX (Release 1.4.0, 19.09.2017)
33+
- NIX library (stable release 1.4.1 build, compiled using BOOST 1.57.0, CPPUNIT 1.13.2 and HDF 1.10.1)
34+
- NIX-MX (Release 1.4.1)
3035

3136
**Build NIX-MX under Windows**
3237

33-
To build NIX-MX under Windows please follow the guide provided at [WinBuild.md](https://github.com/G-Node/nix-mx/blob/master/WinBuild.md). For an automated build, you can also use the `win_build.bat` script after you have read the build guide and set up all required paths and repositories accordingly.
38+
To build NIX-MX under Windows please follow the guide provided at [WinBuild.md](https://github.com/G-Node/nix-mx/blob/master/WinBuild.md).
39+
For an automated build, you can also use the `win_build.bat` script after you have read
40+
the build guide and set up all required paths and repositories accordingly.
3441

3542

3643
Getting Started (macOS)
3744
-------------------------------
3845

39-
**Quick start packages, Release 1.4.0**
46+
**Quick start packages, Release 1.4.1**
4047

4148
The quick start packages (https://github.com/G-Node/nix-mx/releases)
42-
are compiled under macOS Sierra using Matlab 2016b and contain the compiled mex files, nix m-files, tests, and a startup.m script. To use nix-mx unzip the file and run the startup.m script in MATLAB. This simply adds the current folder containing the mex files to the MATLAB path. Do not change the file/folder structure.
49+
are compiled under macOS Sierra using Matlab 2016b and contain the compiled mex files,
50+
nix m-files, tests, and a `startup.m` script. To use nix-mx unzip the file and run the
51+
`startup.m` script in MATLAB. This simply adds the current folder containing the mex
52+
files to the MATLAB path. Do not change the file/folder structure.
4353

4454

45-
In order to have it working the respective NIX C++ library must be installed on the system. The easiest way is using homebrew `brew install nixio`
55+
In order to have it working the respective NIX C++ library must be installed on the
56+
system. The easiest way is using homebrew `brew install nixio`
4657

47-
Once this is done, you may want to test it. Go to the MATLAB command line, change into the nix-mx folder and execute:
58+
Once this is done, you may want to test it. Go to the MATLAB command line, change into
59+
the nix-mx folder and execute:
4860

4961
`>>RunTests`
5062

0 commit comments

Comments
 (0)