Skip to content

Commit

Permalink
Fix README.md formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
keithfma committed Feb 24, 2020
1 parent c1c8895 commit c8ea54f
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

**Create new MAT-files optimized for partial reading and writing of large arrays.**

See the demo at: http://www.allnans.com/newmatic/newmatic_demo.html
+ Demo at: http://www.allnans.com/newmatic/newmatic_demo.html
+ Blog at: http://www.allnans.com/jekyll/update/2020/02/23/newmatic.html

This tool solves a few problems I ran into when using
[matfile](https://www.mathworks.com/help/matlab/ref/matlab.io.matfile.html),
Expand Down Expand Up @@ -32,10 +33,6 @@ Additional notes:
+ `newmatic` only allocates arrays. If you want to include other data types
(strings, cell arrays, whatever), you can add them to the file created by
`newmatic` in the usual way.
+ This initial version of `newmatic` depends on the system CLI
[h5repack](https://support.hdfgroup.org/HDF5/doc/RM/Tools.html#Tools-Repack),
a future update will drop this dependency in favor of the native MATLAB hdf5
interface.

## Example Usage

Expand All @@ -56,3 +53,8 @@ mat = newmatic(...
mat.z = {'a', 'cell', 'array'};
```

## References

Special shout out to the [hdf5storage](https://github.com/frejanordsiek/hdf5storage) python package for
helping me work out the details of making a MATLAB-compatible HDF5 file.

0 comments on commit c8ea54f

Please sign in to comment.