Skip to content
This repository was archived by the owner on Mar 7, 2019. It is now read-only.

Commit 4c50c27

Browse files
author
acbetter
committed
update readme.
1 parent c102d9e commit 4c50c27

File tree

1 file changed

+10
-21
lines changed

1 file changed

+10
-21
lines changed

README.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,23 @@ Convert MATLAB Help Document to Docset for Dash.app to use.
66

77
## How to Use?
88

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).
1010

11-
```shell
12-
brew install python3
13-
```
11+
Then open `Termainal.app` and input this command:
1412

15-
2. Install the dependence.
13+
```shell
14+
chmod +x matlab2docset && ./matlab2docset
15+
```
1616

17-
```shell
18-
pip3 install beautifulsoup4
19-
pip3 install lxml
20-
```
17+
Please wait for a minutes...
2118

22-
or change your directory to `matlab2dash/` and use this command:
19+
[![asciicast](https://asciinema.org/a/187621.png)](https://asciinema.org/a/187621)
2320

24-
```shell
25-
pip install -r requirements.txt
26-
```
21+
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.
2722

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...
2924

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
3726

3827
Please post bugs and issues on [github](https://github.com/acbetter/matlab2docset/issues). Thank you!
3928

0 commit comments

Comments
 (0)