Skip to content

Commit b089c65

Browse files
authored
Update README.md
updated README text
1 parent f2089bc commit b089c65

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
11
# CustomizeAxes
22
Live task to customize Matlab axes interactively
3+
4+
## Setup/usage as a live task
5+
1. Download the CustomizeAxes files to your computer
6+
2. Add the CustomizeAxes folder path to Matlab using the `addpath` function or the "Set Path" button in the Matlab Desktop toolstrip. If you use `addpath`, you need to ensure to run it in every Matlab session, otherwise the live task will not be accessible in the Editor.
7+
3. Run `matlab.task.configureMetadata([folder '/CustomizeAxes'])` in Matlab (replace `folder` with the CustomizeAxes path above)
8+
4. In the Matlab Editor, start a New Live Script, click the "Task" dropdown in the toolstrip, and ensure that you see the CustomizeAxes task:
9+
![image](https://user-images.githubusercontent.com/10243182/200378631-f49977eb-3e8a-47fc-8588-a734954518df.png)
10+
5. Insert the live task into your live Matlab script by clicking the live task button. Here is a usage example:
11+
![image](https://github.com/altmany/CustomizeAxes/blob/main/CustomizeAxes%20Live%20task.png?raw=true)
12+
13+
## Running as a standalone dialog window
14+
CustomizeAxes can also run as a standalong window, using the syntax `CustomizeAxes(haxes)`, where hAxes is the requested axes handle.
15+
You can also run `CustomizeAxes()` without an axes handle, allowing you to interactively select the requested axes.
16+
![image](https://github.com/altmany/CustomizeAxes/blob/main/CustomizeAxes%20dialog%20window.png?raw=true)

0 commit comments

Comments
 (0)