You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 7, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-21Lines changed: 10 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,34 +6,23 @@ Convert MATLAB Help Document to Docset for Dash.app to use.
6
6
7
7
## How to Use?
8
8
9
-
1. Please use `Python3` and `macOS`
9
+
Open our [releases page](https://github.com/acbetter/matlab2dash/releases) and download the [binary file (about 10 MB)](https://github.com/acbetter/matlab2dash/releases/download/v1.1/matlab2docset).
10
10
11
-
```shell
12
-
brew install python3
13
-
```
11
+
Then open `Termainal.app` and input this command:
14
12
15
-
2. Install the dependence.
13
+
```shell
14
+
chmod +x matlab2docset && ./matlab2docset
15
+
```
16
16
17
-
```shell
18
-
pip3 install beautifulsoup4
19
-
pip3 install lxml
20
-
```
17
+
Please wait for a minutes...
21
18
22
-
or change your directory to `matlab2dash/` and use this command:
The script will auto find the `MATLAB.app` which was installed in your computer and create the docset file in your `~/Downloads` directory. The size of the docset file will be about 1.6 GB, so please wait it.
27
22
28
-
3. Run the Python Script.
23
+
Why 1.6 GB? Because of the new verison Dash doesn't support `os.symlink` feature, so I can't use system link to link the docset. So the docset file copy all the `MATLAB.app` help documents which is about 1.6 GB...
29
24
30
-
```shell
31
-
python3 matlab2docset.py
32
-
```
33
-
34
-
4. The script will auto find the `MATLAB.app` which was installed in your computer and create the docset file in your `~/Downloads` directory. The size of the docset file will be limited in 1MB.
35
-
36
-
## Contact
25
+
## Contact && Bugs Report
37
26
38
27
Please post bugs and issues on [github](https://github.com/acbetter/matlab2docset/issues). Thank you!
0 commit comments