Skip to content

Commit 553760b

Browse files
committed
[README] v1.4 release
1 parent c422bb2 commit 553760b

File tree

3 files changed

+14
-16
lines changed

3 files changed

+14
-16
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
How to contribute to nix-mx
22
===========================
33

4-
This document gives some information about how to contribute to the nix-mx project.
4+
This document gives some information about how to contribute to the [nix-mx](https://github.com/G-Node/nix-mx) project.
55

66

77
Contributing

MacOSBuild.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ To compile NIX-MX for macOS for your MATLAB Version follow these steps:
55

66
**Dependencies**
77

8-
- You have to have a woring build environment including a C++ compiler
9-
- Install the nix C++ libraries (e.g. via homebrew `brew install nixio`) to build it from source please visit [NIX](https://github.com/G-Node/nix).
8+
- You have to have a working build environment including a C++ compiler
9+
- Install the nix C++ libraries (e.g. via homebrew `brew install nixio`) to build it from source please visit [NIX](https://github.com/G-Node/nix)
1010
- Install cmake and the boost libraries (e.g. via homebrew `brew install boost; brew install cmake`
1111
- Clone the nix-mx repository `git clone https://github.com/g-node/nix-mx.git`
1212
- Change into the directory and create a build subfolder: `mkdir build`

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,36 @@ The *NIX-MX* project is an extension to [NIX](https://github.com/G-Node/nix) and
77
Development Status
88
------------------
99

10-
The *NIX-MX* project has been developed and tested solely under Windows 32 and Windows 64 and is in a beta stage of development. Specifically 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.
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.
1111

1212

1313
Getting Started (Windows 32/64)
1414
-------------------------------
1515

16-
**Quick start packages, Beta-Release 1.1.0**
16+
**Quick start packages, Release 1.4.0**
1717

1818
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.3.2 build](https://github.com/G-Node/nix/releases/tag/1.3.2) . 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.
20-
21-
The Windows 32 package contains:
22-
- HDF5 dlls (Release 1.8.14)
23-
- NIX dll (stable release 1.3.2 build, compiled using BOOST 1.57.0 and CPPUNIT 1.13.2)
24-
- NIX-MX (Beta-Release 1.3.0, 10.02.2017)
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.
2520

2621
The Windows 64 package contains:
2722
- HDF5 dlls (Release 1.8.14)
28-
- NIX dll (stable release 1.3.2 build, compiled using BOOST 1.57.0 and CPPUNIT 1.13.2)
29-
- NIX-MX (Beta-Release 1.3.0, 10.02.2017)
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)
3025

31-
NOTE: there was a small bugfix in examples/Primer.m after the latest release. If you want to use this small tutorial, please replace examples/Primer.m in your extracted quick start package with the corresponding file from the master branch.
26+
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)
3230

3331
**Build NIX-MX under Windows**
3432

35-
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)
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.
3634

3735

3836
Getting Started (macOS)
3937
-------------------------------
4038

41-
**Quick start packages, Beta-Release 1.4.0**
39+
**Quick start packages, Release 1.4.0**
4240

4341
The quick start packages (https://github.com/G-Node/nix-mx/releases)
4442
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.

0 commit comments

Comments
 (0)