Skip to content

Commit

Permalink
Add Matlab-specific readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
cbm755 committed May 12, 2015
1 parent 0057827 commit b2dfbc4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ matlab_pkg:
cp -ra COPYING tmp/${MATLAB_PKG_DIR}/
cp -ra CONTRIBUTORS tmp/${MATLAB_PKG_DIR}/
cp -ra NEWS tmp/${MATLAB_PKG_DIR}/
cp -ra README.matlab.md tmp/${MATLAB_PKG_DIR}/
pushd tmp; zip -r ${MATLAB_PKG_DIR}.zip ${MATLAB_PKG_DIR}; popd
mv tmp/${MATLAB_PKG_DIR}.zip .

22 changes: 22 additions & 0 deletions README.matlab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Running Doctest on Matlab
=========================

The Doctest package finds specially-formatted blocks of example code
within documentation files. It then executes the code and confirms
the output is correct. This can be useful as part of a testing
framework or simply to ensure that documentation stays up-to-date
during software development.

The package is designed for Octave but aims to be compatible with
Matlab as well.

See `help doctest` for documention and other information.


Installation
------------

To install on Matlab, download the `doctest-matlab-x.y.z.zip` file and
unzip it somewhere. Add it to your Matlab path (e.g., with the Matlab
`addpath` command). Type `doctest doctest` to have Doctest test
itself.

0 comments on commit b2dfbc4

Please sign in to comment.