Skip to content

Commit 23da213

Browse files
committed
Add quick start package
Add description and link to quick start package
1 parent b4e0e45 commit 23da213

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
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 Matlab bindings for *NIX*.
55

66

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 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.
10+
The *NIX-MX* project has been developed and tested solely under Windows 32 and Windows 64 and is in an alpha 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.
1111

1212

1313
Getting Started (Windows 32/64)
14-
-------------------------
14+
-------------------------------
15+
16+
**Quick start packages, Pre-Release 1.01**
17+
18+
The [quick start packages] (https://github.com/G-Node/nix-mx/releases/tag/v1.01-Pre-Release) 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+
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 (build commit f357124d0ec5028d4574e4f5816cca7b8d7c9e8b, compiled using BOOST 1.57.0 and CPPUNIT 1.13.2)
24+
- NIX-MX (Pre-Release 1.01, 22.06.2015)
25+
26+
The Windows 64 package contains:
27+
- HDF5 dlls (Release 1.8.14)
28+
- NIX dll (build commit f357124d0ec5028d4574e4f5816cca7b8d7c9e8b, compiled using BOOST 1.57.0 and CPPUNIT 1.13.2)
29+
- NIX-MX (Pre-Release 1.01, 22.06.2015)
1530

16-
As of now there is no Windows installer for NIX-MX.
1731

1832
**Build NIX-MX under Windows**
1933

20-
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)
34+
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)

0 commit comments

Comments
 (0)