diff --git a/README.md b/README.md index a0fd0ee..020ee91 100644 --- a/README.md +++ b/README.md @@ -25,31 +25,20 @@ MATLAB R2022b or newer is recommended. Install MATLAB with the above products an *Note - You may need to rebuild the S-Function if you are using an older release of MATLAB*. ### Simulink Blockset for MuJoCo - -#### Windows®: - -- Download the [latest release for Windows](https://github.com/mathworks-robotics/mujoco-simulink-blockset/releases/latest) (Release_win64***.zip) -- Open MATLAB R2022b. In case you are using an older MATLAB release, please follow the build instructions below to rebuild for a particular MATLAB release -- Run the install.m in the MATLAB command window. MuJoCo and GLFW libraries will be downloaded and added to MATLAB Path. - -#### Ubuntu®: - -Ubuntu prebuilt release artifacts will be added later. Goto 'Build Instructions' below to build from the source code. - - -#### Note: -*The 'Download' button from File Exchange only downloads the source code. If you use the download button, ensure that you run the 'Build Instructions' before continuing.* +- Download the latest release of this repository (MATLAB Toolbox - MLTBX file) +- Open MATLAB R2022b or higher and install the downloaded MATLAB Toolbox file +- Run the setup function packaged in the toolbox. MuJoCo (and GLFW for Windows users) library is downloaded and added to MATLAB path. + + `>>mujoco_interface_setup` ## Usage -Open examples/gettingStarted.slx model and click run +`>>mj_gettingStarted` + +Open the example model and run it in normal simulation mode. If the installation is successful, you should see a pendulum model running in a separate window and camera streams displayed by Video Viewer blocks (Computer Vision Toolbox). @@ -84,6 +73,8 @@ Steps for building/rebuilding the C-MEX S-Function code. These instructions are - Microsoft® Visual Studio® 2022 or higher (recommended) - (or) [MinGW (GCC 12.2.0 or higher)](https://community.chocolatey.org/packages/mingw) - Clone this repository + + `$ git clone git@github.com:mathworks-robotics/mujoco-simulink-blockset.git` - Launch MATLAB and open the repository folder - `>> install` - Open tools/