From ff523ac7062b930789e0b8e1614d877c14480690 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 22 Jul 2024 11:43:19 +0530 Subject: [PATCH] Automated documentation update [skip ci] (#1) Co-authored-by: github-actions[bot] --- src/matlab/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/matlab/README.md b/src/matlab/README.md index 56c10bb..708b88f 100644 --- a/src/matlab/README.md +++ b/src/matlab/README.md @@ -1,7 +1,7 @@ # MATLAB (matlab) -Installs MATLAB, supporting packages and tools. +Installs MATLAB with supporting packages and tools. ## Example Usage @@ -16,16 +16,16 @@ Installs MATLAB, supporting packages and tools. | Options Id | Description | Type | Default Value | |-----|-----|-----|-----| | release | MATLAB Release to install. | string | r2024a | -| products | Products to install, specified as a list of product names separated by spaces.
See [MPM.md](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md#product-installation-options) for more information on product specification and availability. | string | MATLAB | -| doc | Flag to install documentation and examples. (R2022b and earlier releases) | boolean | false | -| installGpu | Skips installation of GPU libraries when you install Parallel Computing Toolbox. (R2023a and later releases) | boolean | false | +| products | Products to install, specified as a list of space-separated product names.
For details of products, see [MATLAB Package Manager](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md#product-installation-options). | string | MATLAB | +| doc | Flag to install documentation and examples (R2022b and earlier releases). | boolean | false | +| installGpu | Skips installation of GPU libraries when you install Parallel Computing Toolbox (R2023a and later releases). | boolean | false | | destination | Full path to the installation destination folder. | string | /opt/matlab/$RELEASE | -| installMatlabProxy | Installs matlab-proxy and its dependencies. (R2020b and later releases) | boolean | false | -| installJupyterMatlabProxy | Installs jupyter-matlab-proxy and its dependencies. (R2020b and later releases) | boolean | false | +| installMatlabProxy | Installs matlab-proxy and its dependencies (R2020b and later releases). | boolean | false | +| installJupyterMatlabProxy | Installs jupyter-matlab-proxy and its dependencies (R2020b and later releases). | boolean | false | | installMatlabEngineForPython | Installs the MATLAB Engine for Python if the destination option is set correctly. | boolean | false | -| startInDesktop | Starts matlab-proxy on container start. | string | false | +| startInDesktop | Starts matlab-proxy when container starts. | string | false | | networkLicenseManager | MATLAB will use the specified Network License Manager. | string | - | -| skipMATLABInstall | Set to true if you dont want to install MATLAB. Useful if you only want to install the proxy products. | boolean | false | +| skipMATLABInstall | Set to true if you do not want to install MATLAB, for example if you only want to install `matlab-proxy` or `jupyter-matlab-proxy`. | boolean | false | ## Customizations