Skip to content

Commit e1d933f

Browse files
committed
Re #50 minor changes from review and typos
1 parent c66c257 commit e1d933f

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,38 @@ folder while the build will be placed in a build folder. The build requires a py
99
in the requirements.txt. You need MATLAB version and python version or RAT software installed in your system.
1010

1111
```bash
12-
conda create -n RAT python=3.9
13-
conda activate RAT
14-
pip install -r requirements.txt
12+
conda create -n RAT python=3.9
13+
conda activate RAT
14+
pip install -r requirements.txt
1515
```
1616

1717
You also must have `pandoc` installed to build the Python example Jupiter notebooks. See the installation instructions [here](https://pandoc.org/installing.html). If not previously installed system-wide, install [pandoc](https://pandoc.org/) using [conda](https://docs.conda.io/) as described in their [installation manual](https://pandoc.org/installing.html#conda-forge)
1818
depending on [conda](https://docs.conda.io/) flavour you are using.
1919

20-
If you do not have RAT code on your machine, download the appropriate version of RAT from the GitHub [release](https://github.com/RascalSoftware/RAT/releases) page, and unzip the contents into a folder called API (This folder should be located within RAT-doc directory, alongside main `.github` folder). For example on a Linux machine, the nightly can be downloaded as shown:
20+
If you do not have RAT code on your machine, download the appropriate version of RAT from the GitHub [release](https://github.com/RascalSoftware/RAT/releases) page, and unzip the contents into a folder called API (This folder should be located within RAT-doc directory, alongside the **source** folder and main `make.bat` file (see below)). For example on a Linux machine, the nightly can be downloaded as shown:
2121

2222
```bash
23+
cd path_to_rat_docs_folder
2324
wget https://github.com/RascalSoftware/RAT/releases/download/nightly/Linux.zip
2425
unzip Linux.zip -d API/
2526
```
2627

28+
Where `path_to_rat_docs_folder` is the location where documentation is cloned or unpacked.
2729
If RAT is already present, you may create symbolic link to the existing` RAT` directory, e.g.:
2830

2931
for Windows:
3032

3133
cd path_to_rat_docs_folder
32-
mklink /j API path_to_matlap_rat_folder
34+
mklink /j API path_to_matlab_rat_folder
3335

3436
for linux/macOS:
3537

3638
```bash
37-
cd path_to_rat_docs_folder
38-
ln -s path_to_matlap_rat_folder API
39+
cd path_to_rat_docs_folder
40+
ln -s path_to_matlab_rat_folder API
3941
```
4042

41-
Where `path_to_rat_docs_folder` is the path to the RAT documentation repository and `path_to_matlap_rat_folder` is the path to the downloaded MATLAB RAT release
43+
Where `path_to_rat_docs_folder` is the path to the RAT documentation repository and `path_to_matlab_rat_folder` is the path to the downloaded MATLAB RAT release
4244

4345
[Python RAT API](https://github.com/RascalSoftware/python-RAT) should be installed on the same python virtual environment created earlier. Build process adds modules necessary for generating python documentation to the python modules search path. Look at [Python RAT repository](https://github.com/RascalSoftware/python-RAT/blob/main/README.md) for more information on how to build python API.
4446

0 commit comments

Comments
 (0)