Skip to content

Commit 5d01bf4

Browse files
author
Caspar Gruijthuijsen
committed
updated readme/install message with matlab syntax instructions
1 parent 0f23cc5 commit 5d01bf4

File tree

2 files changed

+14
-19
lines changed

2 files changed

+14
-19
lines changed

README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ Getting started
3737
- __Function documentation generation__
3838
Works out of the box! Try pressing <kbd>Ctrl + Alt + m</kbd> in a Matlab function file to see what it does. If you are interested in more tailored functionality, have a look [here](#function-documentation-generation).
3939

40-
*Note: AutoMatlab currently only supports Matlab installations on __Windows__*.
40+
*Note 1: AutoMatlab currently only supports Matlab installations on __Windows__*.
41+
*Note 2: Make sure that the syntax of `.m` files is set to Matlab (by default):*
42+
43+
View > Syntax (> Open all with current extension as...) > Matlab
4144

4245
Autocompletion
4346
--------------
@@ -211,13 +214,3 @@ The following settings can be added to the `.sublime-project` file to adapt the
211214
}
212215
}
213216
```
214-
215-
Roadmap
216-
-------
217-
218-
- [ ] Support for Matlab classes
219-
- [ ] Class autocompletion
220-
- [ ] Class documentation generation
221-
- [ ] Support for other OS's
222-
- [ ] Mac
223-
- [ ] Linux

messages/install.txt

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ AutoMatlab aims to make writing Matlab code fun again by combining the strengths
77

88
If you have any questions, suggestions, or comments, don't hesitate to let me know.
99

10-
*Note: AutoMatlab currently only supports Matlab installations on __Windows__*.
11-
1210
Getting started
1311
---------------
1412

15-
- __Autocompletion__
16-
Works out of the box! Start typing or try pressing <kbd>Ctrl + Space</kbd> to see what it does.
17-
- __Matlab commands__
18-
Depends on [AutoHotkey](https://www.autohotkey.com/). If AutoHotkey is installed and `auto_hotkey_path` correctly specified in the AutoMatlab settings, try pressing <kbd>Ctrl + b</kbd> to run the current file in Matlab or <kbd>Alt + m</kbd> to open the AutoMatlab Command Panel.
19-
- __Function documentation generation__
20-
Works out of the box! Try pressing <kbd>Ctrl + Alt + m</kbd> in a Matlab function file to see what it does.
13+
- Autocompletion:
14+
Works out of the box! Start typing or try pressing `Ctrl + Space` to see what it does.
15+
- Function documentation generation:
16+
Works out of the box! Try pressing `Ctrl + Alt + m` in a Matlab function file to see what it does.
17+
- Matlab commands:
18+
Depends on AutoHotkey (https://www.autohotkey.com). If AutoHotkey is installed and `auto_hotkey_path` correctly specified in the AutoMatlab settings, try pressing `Ctrl + b` to run the current file in Matlab or `Alt + m` to open the AutoMatlab Command Panel.
2119

2220
If you are interested in more tailored functionality, have a look at the extensive documentation in the README.
2321

22+
Note 1: AutoMatlab currently only supports Matlab installations on Windows.
23+
24+
Note 2: Make sure that the syntax of `.m` files is set to Matlab (by default):
25+
View > Syntax (> Open all with current extension as...) > Matlab

0 commit comments

Comments
 (0)