Skip to content

Commit a7f6c97

Browse files
authored
Update README.md
1 parent 86a61d6 commit a7f6c97

File tree

1 file changed

+5
-22
lines changed

1 file changed

+5
-22
lines changed

README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@ This repository provides a Simulink® C-MEX S-Function block interface to the
44

55
[![View <File Exchange Title> on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/128028-mujoco-simulink-blockset)
66

7-
Useful for,
8-
1. Robot simulation (mobile, biomimetics, grippers, robotic arm)
9-
2. Development of autonomous algorithms
10-
3. Camera (RGB, Depth) rendering
7+
This blockset enables an easy access to MuJoCo Physics Engine and exposes the GUI, control inputs, sensors and RGB/Depth Cameras from the engine.
118

129
## Installation Instructions
1310

@@ -22,22 +19,6 @@ Useful for,
2219

2320
MATLAB R2022b or newer is recommended. Install MATLAB with the above products and then proceed to set up MuJoCo blocks.
2421

25-
*Note - You may need to rebuild the S-Function if you are using an older release of MATLAB*.
26-
27-
### Simulink Blockset for MuJoCo
28-
29-
- (Linux users) Install GLFW library from Ubuntu terminal
30-
31-
`sudo apt update && sudo apt install libglfw3 libglfw3-dev`
32-
- Download the latest source zip of this repository and store it in some location (preferably not in Downloads)
33-
- Open MATLAB R2022b or higher and open the repo folder.
34-
- Run the setup function packaged in the toolbox. MuJoCo (and GLFW for Windows users) library is automatically downloaded and added to MATLAB path.
35-
36-
`>>install`
37-
- (Linux users) The default pathdef.m is likely not saveable in Linux. Save pathdef.m to new location as given in this [MATLAB answer](https://www.mathworks.com/matlabcentral/answers/1653435-how-to-use-savepath-for-adding-path-to-pathdef-m-in-linux).
38-
`savepath ~/Documents/MATLAB/pathdef.m`
39-
- Now follow the build instructions provided below. The prebuilt binaries are no longer shipped.
40-
4122
## Build Instructions (mandatory)
4223

4324
Steps for building/rebuilding the C-MEX S-Function code. These instructions are only required if you are cloning the repository instead of downloading the release.
@@ -47,7 +28,7 @@ Steps for building/rebuilding the C-MEX S-Function code. These instructions are
4728
- Install one of the following C++ Compiler
4829
- Microsoft&reg; Visual Studio&reg; 2022 or higher (recommended)
4930
- (or) [MinGW (GCC 12.2.0 or higher)](https://community.chocolatey.org/packages/mingw)
50-
- Clone this repository
31+
- Clone this repository or download the source zip (preferably not in Downloads folder)
5132

5233
`$ git clone git@github.com:mathworks-robotics/mujoco-simulink-blockset.git`
5334
- Launch MATLAB and open the repository folder
@@ -63,11 +44,13 @@ Steps for building/rebuilding the C-MEX S-Function code. These instructions are
6344
- Install the tools required for compiling the S-Function
6445

6546
`$ sudo apt update && sudo apt install build-essential git libglfw3 libglfw3-dev `
66-
- Clone this repository
47+
- Clone this repository or download the source zip (preferably not in Downloads folder)
6748

6849
`$ git clone git@github.com:mathworks-robotics/mujoco-simulink-blockset.git`
6950
- Launch MATLAB and open the repository folder. Run the install.m script.
7051
- `>> install`
52+
- The default pathdef.m is likely not saveable in Linux. Save pathdef.m to new location as given in this [MATLAB answer](https://www.mathworks.com/matlabcentral/answers/1653435-how-to-use-savepath-for-adding-path-to-pathdef-m-in-linux).
53+
`savepath ~/Documents/MATLAB/pathdef.m`
7154
- Open tools/ and run the following commands in MATLAB command Windows
7255
- `>> setupBuild`
7356
- `>> mex -setup c++`

0 commit comments

Comments
 (0)