diff --git a/README.md b/README.md index 0fc5206..e372643 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ MOcov is a coverage report generator for Matlab and GNU Octave. + ### Features - Runs on both the [Matlab] and [GNU Octave] platforms. @@ -35,6 +36,7 @@ MOcov is a coverage report generator for Matlab and GNU Octave. savepath % save the path ``` + ### Generating coverage reports There are two methods to generate coverage while evaluating a particular expression: @@ -43,6 +45,7 @@ There are two methods to generate coverage while evaluating a particular express 2) the 'profile' method uses the Matlab profiler. This method runs on Matlab only, but is generally faster. + ### Use cases Typical use cases for MOcov are: @@ -97,10 +100,16 @@ Typical use cases for MOcov are: ### Use with travis-ci and Shippable MOcov can be used with the [Travis-ci] and [Shippable] services for continuous integration testing. This is achieved by setting up a `travis.yml` file. Due to recursiveness issues, MOcov cannot use these services to generate coverage reports for itself; but for an example, see the [MOxUnit .travis.yml] file. + ### Compatibility notes - Because GNU Octave 3.8 and 4.0 do not support `classdef` syntax, 'old-style' object-oriented syntax is used for the class definitions. +### Limitations +- The 'file' method uses a very simple parser, which may not work as expected in all cases. +- Currently there is only support to generate coverage reports for files in a single directory (and its subdirectory). + + ### Contact Nikolaas N. Oosterhof, nikolaas dot oosterhof at unitn dot it