Skip to content

Commit 62af95d

Browse files
committed
READMEs include direct links to images, and licensing updated to include student and home
1 parent a5a5181 commit 62af95d

File tree

4 files changed

+9
-10
lines changed

4 files changed

+9
-10
lines changed

MATLAB-Licensing-Info.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ Based on the license that you want to use, you can follow the procedures outline
2222

2323
| License Type | Procedure |
2424
| ------ | ------ |
25-
| Individual (that only you use and is in your name; not a Home or Student) | Your license is already configured for use with MATLAB Integration for Jupyter. Using the _Online License Manager_ tab, enter the credentials to your MathWorks account to get started. |
25+
| Individual, Home or Student (that only you use and is in your name) | Your license is already configured for use with MATLAB Integration for Jupyter. Using the _Online License Manager_ tab, enter the credentials to your MathWorks account to get started. |
2626
| Campus-Wide License | Your license is already configured for use with MATLAB Integration for Jupyter. Using the _Online License Manager_ tab, enter the credentials to your MathWorks account to get started. |
27-
| Home and Student (that only you use and is in your name) | These license types are not supported for use with MATLAB Integration for Jupyter. |
2827
| Concurrent and Network Named User | Using the _Network License Manager_ tab, enter the address to your organization’s network license manager. You can contact your license administrator* to find the address for the network license manager. |
2928

3029

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ This repository shows how you can access MATLAB® from your Jupyter® environmen
88
Once installed, you can:
99
|Capability| Example|
1010
|--|--|
11-
|**Run MATLAB code in Jupyter notebook** | <p align="center"><img width="600" src="img/JupyterKernel.gif"></p>|
12-
|**Access MATLAB in a browser**|<p align="center"><img width="600" src="img/JupyterMATLABDesktop.gif"></p>|
11+
|**Run MATLAB code in Jupyter notebook** | <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterKernel.gif"></p>|
12+
|**Access MATLAB in a browser**|<p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterMATLABDesktop.gif"></p>|
1313

1414
This package supports both Jupyter Notebook and JupyterLab. Some capabilities are limited to the JupyterLab interface.
1515

@@ -88,7 +88,7 @@ environment should present several options for using MATLAB in Jupyter.
8888

8989
|Classic Jupyter | JupyterLab |
9090
|--|--|
91-
|<p align="center"><img width="200" src="img/classic-jupyter.png"></p> | <p align="center"><img width="500" src="img/jupyterlab_icons.png"></p> |
91+
|<p align="center"><img width="200" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter.png"></p> | <p align="center"><img width="500" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab_icons.png"></p> |
9292

9393
## Detailed Usage
9494

@@ -97,7 +97,7 @@ Click the icon below to launch a notebook:
9797

9898
|Icon | Notebook |
9999
|--|--|
100-
|<p align="center"><img width="100" src="img/matlab-kernel-button.png"></p> | <p align="center"><img width="600" src="img/jupyterlab-notebook.png"></p> |
100+
|<p align="center"><img width="100" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/matlab-kernel-button.png"></p> | <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab-notebook.png"></p> |
101101

102102

103103
* The first time you execute code in a MATLAB notebook you will be asked to log in or use a network license manager. Follow the [licensing](#licensing) instructions below.
@@ -113,7 +113,7 @@ For more information, see [MATLAB Kernel for Jupyter](src/jupyter_matlab_kernel/
113113
Click the icon below to open a browser-based version of the MATLAB development environment:
114114
|Icon | Desktop |
115115
|--|--|
116-
|<p align="center"><img width="100" src="img/matlab-desktop-button.png"></p> | <p align="center"><img width="600" src="img/jupyter_matlab_desktop.png"></p> |
116+
|<p align="center"><img width="100" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/matlab-desktop-button.png"></p> | <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyter_matlab_desktop.png"></p> |
117117

118118
* Notebooks in JupyterLab, also have a `Open MATLAB` shortcut on the top to access the MATLAB desktop.
119119
|![open-matlab-button](img/open-matlab-button.png)
@@ -125,7 +125,7 @@ For more information, see [Open MATLAB in a browser](src/jupyter_matlab_proxy/RE
125125
Click the icon below to start editing a new MATLAB file in a new JupyterLab tab:
126126
|Icon | MATLAB File |
127127
|--|--|
128-
|<p align="center"><img width="100" src="img/new-matlab-file-button.png"></p> | <p align="center"><img width="600" src="img/new-matlab-file.png"></p> |
128+
|<p align="center"><img width="100" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/new-matlab-file-button.png"></p> | <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/new-matlab-file.png"></p> |
129129
* MATLAB code in this file will include syntax highlighting.
130130
* You can also use the command palette, by using `CTRL+SHIFT+C` and then typing `New MATLAB File`.
131131
* Execution of `MATLAB Files (.m)` files in JupyterLab is currently **not** supported.

src/jupyter_matlab_kernel/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Click on `MATLAB Kernel` to create a Jupyter notebook for MATLAB.
1010

1111
|Jupyter Notebook| JupyterLab |
1212
|--|--|
13-
|<p align="center"><img width="200" src="../../img/classic-jupyter.png"></p> | <p align="center"><img width="500" src="../../img/jupyterlab-notebook-section.png"></p> |
13+
|<p align="center"><img width="200" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter.png"></p> | <p align="center"><img width="500" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab-notebook-section.png"></p> |
1414

1515
## Architecture
1616

src/jupyter_matlab_proxy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To report any issues or suggestions, see the [Feedback](#feedback) section.
1717

1818
|Jupyter Notebook| JupyterLab |
1919
|--|--|
20-
|<p align="center"><img width="600" src="../../img/classic-jupyter.png"></p> | <p align="center"><img width="600" src="../../img/jupyterlab-notebook-section.png"></p> |
20+
|<p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter.png"></p> | <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab-notebook-section.png"></p> |
2121

2222
* To enter your license information, see [Licensing](../../README.md#licensing).
2323

0 commit comments

Comments
 (0)