diff --git a/README.rst b/README.rst index f690141..1b94a1f 100644 --- a/README.rst +++ b/README.rst @@ -64,12 +64,12 @@ following command: addpath('/path/to/zmat'); -For Octave, one needs to copy the zipmat.mat file inside the "octave", -from the subfolder matching the OS into the "private" subfolder. +For Octave, one needs to copy the zipmat.mat file inside the "``octave``", +from the subfolder matching the OS into the "``private``" subfolder. If you want to add this path permanently, you need to type "pathtool", browse to the zmat root folder and add to the list, then click "Save". -Then, run "rehash" in MATLAB, and type "which zmat", if you see an +Then, run "``rehash``" in MATLAB, and type "``which zmat``", if you see an output, that means ZMax is installed for MATLAB/Octave. If you use MATLAB in a shared environment such as a Linux server, the @@ -80,15 +80,15 @@ best way to add path is to type mkdir ~/matlab/ nano ~/matlab/startup.m -and type addpath('/path/to/zmax') in this file, save and quit the editor. +and type ``addpath('/path/to/zmax')`` in this file, save and quit the editor. MATLAB will execute this file every time it starts. For Octave, the file -you need to edit is ~/.octaverc , where "~" is your home directory. +you need to edit is ``~/.octaverc`` , where "``~``" is your home directory. ================ Using ZMat ================ -ZMat provides a single mex function, zipmat.mex* -- for both compressing/encoding +ZMat provides a single mex function, ``zipmat.mex*`` -- for both compressing/encoding or decompresing/decoding data streams. The help info of the function is shown below