diff --git a/Makefile b/Makefile index f812afe..cf2bb8b 100644 --- a/Makefile +++ b/Makefile @@ -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 . diff --git a/README.matlab.md b/README.matlab.md new file mode 100644 index 0000000..47e618b --- /dev/null +++ b/README.matlab.md @@ -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.