Make installation instructions more explicit in the README.

PiperOrigin-RevId: 456976659
Change-Id: I9bac31771eb62e069107b30122478437b67c2ebf
This commit is contained in:
Kevin Zakka
2022-06-24 03:47:47 -07:00
committed by Copybara-Service
parent 228264c92b
commit afc8395376
+26 -6
View File
@@ -23,21 +23,39 @@ further exposes a large number of utility functions for computing physics-relate
quantities. We also provide Python bindings and a plug-in for the [Unity] quantities. We also provide Python bindings and a plug-in for the [Unity]
game engine. game engine.
## Documentation ## Installation
MuJoCo's documentation is available at [mujoco.readthedocs.io], which serves ### Prebuilt binaries
webpages derived from the [documentation source files].
## Releases
Versioned releases are available as precompiled binaries from the GitHub Versioned releases are available as precompiled binaries from the GitHub
[releases page], built for Linux (x86-64 and AArch64), Windows (x86-64 only), [releases page], built for Linux (x86-64 and AArch64), Windows (x86-64 only),
and macOS (universal). This is the recommended way to use the software. 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 ### Building from source
Users who wish to build MuJoCo from source should consult the [build from
source] section of the documentation. However, please note that the commit at source] section of the documentation. However, please note that the commit at
the tip of the `main` branch may be unstable. the tip of the `main` branch may be unstable.
### Python (>= 3.7)
The native Python bindings, which come pre-packaged with a copy of MuJoCo, can
be installed from [PyPI] via:
```bash
pip install mujoco
```
Note that Pre-built Linux wheels target `manylinux2014`, see
[here](https://github.com/pypa/manylinux) for compatible distributions. For more
information such as building the bindings from source, see the [Python Bindings]
section of the documentation.
## Documentation
MuJoCo's documentation is available at [mujoco.readthedocs.io], which serves
webpages derived from the [documentation source files].
## Getting Started ## Getting Started
There are two easy ways to get started with MuJoCo: There are two easy ways to get started with MuJoCo:
@@ -175,3 +193,5 @@ This is not an officially supported Google product.
[GitHub Issues]: https://github.com/deepmind/mujoco/issues [GitHub Issues]: https://github.com/deepmind/mujoco/issues
[documentation source files]: https://github.com/deepmind/mujoco/tree/main/doc [documentation source files]: https://github.com/deepmind/mujoco/tree/main/doc
[mujoco.readthedocs.io]: https://mujoco.readthedocs.io [mujoco.readthedocs.io]: https://mujoco.readthedocs.io
[Python Bindings]: https://mujoco.readthedocs.io/en/latest/python.html#python-bindings
[PyPI]: https://pypi.org/project/mujoco/