Update README.md and CONTRIBUTING.md to reflect the updated repository.
PiperOrigin-RevId: 435166719 Change-Id: I6531008950a7492c5f6c4557b78492cee0fe8822
This commit is contained in:
+4
-5
@@ -1,10 +1,9 @@
|
|||||||
# How to Contribute
|
# How to Contribute
|
||||||
|
|
||||||
We are in the process of preparing the MuJoCo codebase for open-sourcing.
|
We are still in the process of preparing the MuJoCo codebase for open-sourcing,
|
||||||
When that happens, we will be grateful to receive your contributions.
|
however the full source code for the Python bindings and the Unity plugin are
|
||||||
Until then, you are welcome to participate in discussions, post
|
already released. You are welcome to send us pull requests to improve any part
|
||||||
issues on our tracker, or send us pull requests to improve the sample program
|
of this repository.
|
||||||
code or documentation.
|
|
||||||
|
|
||||||
## Contributor License Agreement
|
## Contributor License Agreement
|
||||||
|
|
||||||
|
|||||||
@@ -9,25 +9,28 @@ interacting with their environment.
|
|||||||
DeepMind has acquired MuJoCo, and we are currently making preparations to open
|
DeepMind has acquired MuJoCo, and we are currently making preparations to open
|
||||||
source the codebase. In the meantime, MuJoCo is available for download as a free
|
source the codebase. In the meantime, MuJoCo is available for download as a free
|
||||||
and unrestricted precompiled binary under the Apache 2.0 license from
|
and unrestricted precompiled binary under the Apache 2.0 license from
|
||||||
[mujoco.org](https://mujoco.org/).
|
the [GitHub Releases page](https://github.com/deepmind/mujoco/releases).
|
||||||
|
|
||||||
MuJoCo's source code will be released through this GitHub repository once it is
|
MuJoCo's source code will be released through this GitHub repository once it is
|
||||||
ready. In the meantime, the repository hosts MuJoCo's documentation, C header
|
ready. In the meantime, the repository hosts MuJoCo's documentation, C header
|
||||||
files for its public API, and sample program code. If you wish to report bugs or
|
files for its public API, sample program code, along with the full source code
|
||||||
make feature requests, please file them as [GitHub Issues]. You are also
|
for the Python bindings and Unity plugin. If you wish to report bugs or make
|
||||||
welcome to make pull requests for the [documentation source files].
|
feature requests, please file them as [GitHub Issues]. You are also welcome to
|
||||||
|
send us pull requests to improve anything that has been released into this
|
||||||
|
repository.
|
||||||
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
MuJoCo is a C/C++ library with a C API, intended for researchers and developers.
|
MuJoCo is a compiled library with a C API, intended for researchers and
|
||||||
The runtime simulation module is tuned to maximize performance and operates on
|
developers. The runtime simulation module is tuned to maximize performance and
|
||||||
low-level data structures which are preallocated by the built-in XML parser and
|
operates on low-level data structures which are preallocated by the built-in XML
|
||||||
compiler. The user defines models in the native MJCF scene description language
|
parser and compiler. The user defines models in the native MJCF scene
|
||||||
-- an XML file format designed to be as human readable and editable as possible.
|
description language -- an XML file format designed to be as human readable and
|
||||||
URDF model files can also be loaded. The library includes interactive
|
editable as possible. URDF model files can also be loaded. The library includes
|
||||||
visualization with a native GUI, rendered in OpenGL. MuJoCo further exposes a
|
interactive visualization with a native GUI, rendered in OpenGL. MuJoCo further
|
||||||
large number of utility functions for computing physics-related quantities, not
|
exposes a large number of utility functions for computing physics-related
|
||||||
necessarily in a simulation loop. Features include
|
quantities, not necessarily in a simulation loop. Features include
|
||||||
|
|
||||||
- Simulation in generalized coordinates, avoiding joint violations.
|
- Simulation in generalized coordinates, avoiding joint violations.
|
||||||
|
|
||||||
@@ -56,10 +59,17 @@ necessarily in a simulation loop. Features include
|
|||||||
|
|
||||||
- Run-time module written in ANSI C and hand-tuned for performance.
|
- Run-time module written in ANSI C and hand-tuned for performance.
|
||||||
|
|
||||||
|
[Python bindings](https://github.com/deepmind/mujoco/tree/main/python) and a
|
||||||
|
[plugin for the Unity game engine](https://github.com/deepmind/mujoco/tree/main/unity)
|
||||||
|
are also provided and are actively supported by the MuJoCo development team.
|
||||||
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
MuJoCo binaries are currently built for Linux, macOS (Intel), and Windows.
|
MuJoCo binaries are currently built for Linux (x86-64 and AArch64),
|
||||||
|
Windows (x86-64 only), and macOS. If you require a build for a different
|
||||||
|
platform, please let us know via [GitHub Issues] or
|
||||||
|
[Discussions](https://github.com/deepmind/mujoco/discussions).
|
||||||
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|||||||
Reference in New Issue
Block a user