From 89d95ad3c70b5b402ba1fbbc7cbb44ce08d3e1ae Mon Sep 17 00:00:00 2001 From: Kevin Zakka Date: Mon, 23 May 2022 07:40:00 -0700 Subject: [PATCH] Nit fixes in README. PiperOrigin-RevId: 450435777 Change-Id: I8d9c969cce1d16560ca50fbda3704ac808c20477 --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3fbac852..bc6cbe8c 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ MuJoCo has a C API and is intended for researchers and developers. The runtime simulation module is tuned to maximize performance and operates on low-level data structures that are preallocated by the built-in XML compiler. The library includes interactive visualization with a native GUI, rendered in OpenGL. MuJoCo -further exposes a large number of utility functions for computing physics- -related quantities. We also provide Python bindings and a plug-in for the Unity +further exposes a large number of utility functions for computing physics-related +quantities. We also provide Python bindings and a plug-in for the [Unity] game engine. ## Documentation @@ -30,8 +30,7 @@ and macOS (universal). This is the recommended way to use the software. Users who wish to build MuJoCo from source, please consult the [build from source] section of the documentation. However, please note that the commit at -the tip of the `main` branch branch may be unstable. - +the tip of the `main` branch may be unstable. ## Getting Started @@ -47,10 +46,9 @@ your machine. If you are a Python user, you might want to start with our tutorial notebooks, running on Google Colab: - - The first tutorial focuses on the basic MuJoco Python bindings: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepmind/dm_control/blob/main/dm_control/mujoco/tutorial.ipynb). - - - The second tutorial includes more examples of `dm_control`-specific functionality: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepmind/dm_control/blob/main/tutorial.ipynb). + - The first tutorial focuses on the basic MuJoco Python bindings: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepmind/dm_control/blob/main/dm_control/mujoco/tutorial.ipynb) + - The second tutorial includes more examples of `dm_control`-specific functionality: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepmind/dm_control/blob/main/tutorial.ipynb) ## Citation @@ -68,7 +66,6 @@ If you use MuJoCo for published research, please cite: } ``` - ## License and Disclaimer Copyright 2021 DeepMind Technologies Limited. @@ -90,6 +87,7 @@ This is not an officially supported Google product. [Getting Started]: https://mujoco.readthedocs.io/en/latest/programming.html#getting-started [acquisition]: https://www.deepmind.com/blog/opening-up-a-physics-simulator-for-robotics [open sourcing]: https://www.deepmind.com/blog/open-sourcing-mujoco +[Unity]: https://unity.com/ [releases page]: https://github.com/deepmind/mujoco/releases [GitHub Issues]: https://github.com/deepmind/mujoco/issues [documentation source files]: https://github.com/deepmind/mujoco/tree/main/doc