gitpan / data-matfile Goto Github PK

   ____        _                __  __    _  _____ _____ _ _      
  |  _ \  __ _| |_ __ _   _ _  |  \/  |  / \|_   _|  ___(_) | ___ 
  | | | |/ _` | __/ _` | (_|_) | |\/| | / _ \ | | | |_  | | |/ _ \
  | |_| | (_| | || (_| |  _ _  | |  | |/ ___ \| | |  _| | | |  __/
  |____/ \__,_|\__\__,_| (_|_) |_|  |_/_/   \_\_| |_|   |_|_|\___|
                                                                  


This is the README for Data::MATFile version 0.02.

Data::MATFile is a "module" for the Perl computer programming language, a
library of computer code to install on a computer.  This document contains four
sections:

1. About - what the module does

2. Documentation - how to learn more about the module

3. Installation - how to install this module on a computer

4. Help - what to do if you get stuck

-----------------------------------------------------------------------------

1. ABOUT

Data::MATFile - read MATLAB MAT-File data

This module provides functions to access the MAT-File format used by
MATLAB and Octave.

-----------------------------------------------------------------------------

2. DOCUMENTATION

You can read the documentation for the module online at the following websites:

    * http://search.cpan.org/perldoc?Data::MATFile
    * http://metacpan.org/release/Data-MATFile

(These links go to the latest version of the module.)

After installing the module, you can read the documentation on your computer
using

    perldoc Data::MATFile

-----------------------------------------------------------------------------

3. INSTALLATION

This module requires Perl version 5.8.1 or later.

To install the module from CPAN, use

    cpan Data::MATFile

If you have the App::cpanminus installer, you may prefer

    cpanm Data::MATFile

To install the module from the source file, Data-MATFile-0.02.tar.gz, follow
this sequence of commands:

    tar xfz Data-MATFile-0.02.tar.gz
    cd Data-MATFile-0.02
    perl Makefile.PL
    make
    make install

If you want to test the module before installing it, use "make test" after
"make" and before "make install".

-----------------------------------------------------------------------------

4. HELP

To get help with the module, you can email the author, Ben Bullock, at
<[email protected]>. If you think there is a problem in the module, you can report a
bug at 

<https://github.com/benkasminbullock/Data-MATFile/issues>,

or if you want to alter the source code of Data::MATFile, try the public
repository on github at 

<https://github.com/benkasminbullock/Data-MATFile>. 

-----------------------------------------------------------------------------

This README was written on Fri Feb  7 09:40:57 2014.

-----------------------------------------------------------------------------