Commit Graph

28 Commits

Author SHA1 Message Date
Yuval Tassa 70952f5f1c Updates to README
PiperOrigin-RevId: 556018026
Change-Id: I1feee93727a92079905d80288b5fd706e3ce800c
2023-08-11 11:07:15 -07:00
Saran Tunyasuvunakool 551a7bbc38 Drop support for Python 3.7.
Python 3.7 reaches end-of-life on 27 June 2023 (https://devguide.python.org/versions/), and future versions of MuJoCo (after 2.3.6) will no longer support it.

PiperOrigin-RevId: 543594006
Change-Id: I66a7db3dab5d08f2fc52912c43e1532080600fc8
2023-06-26 18:05:32 -07:00
Yuval Tassa 87f35b7703 Cite [Simulink Blockset for MuJoCo Simulator](https://github.com/mathworks-robotics/mujoco-simulink-blockset) in Third Party Section of the README.
PiperOrigin-RevId: 541848569
Change-Id: I42ad86979a8bbeb5bb8f8ce9dab06b9cc3c74007
2023-06-20 02:48:38 -07:00
Saran Tunyasuvunakool c9e9cd8b35 Change org name to "Google DeepMind" in various docs.
PiperOrigin-RevId: 540691205
Change-Id: I9eb99eb18893e6748892334470211dbd9d5808db
2023-06-15 14:28:25 -07:00
Kyle Bayes 2644de2438 Fix typo in README.md.
PiperOrigin-RevId: 540549566
Change-Id: Id5446379597f777bdb4bb784a52ff6baa3182e01
2023-06-15 05:18:33 -07:00
Yuval Tassa ea6789b376 Add emoji to README.
PiperOrigin-RevId: 535670105
Change-Id: Ic9bf3e029eb5db8aa30a48c64d3f0d5fdb814f89
2023-05-26 11:27:28 -07:00
Yuval Tassa e338034995 Fix links in README.
PiperOrigin-RevId: 533444487
Change-Id: Ifc1743095f1c4e204360689c681066ca89944804
2023-05-19 07:05:17 -07:00
Yuval Tassa f5936eac7b - Mention mujoco_wasm in README.
- Move Documentation and Getting Started above Installation.
- Delete link to the acquisition and open-sourcing announcements.

PiperOrigin-RevId: 533434989
Change-Id: I5ac9281cee953c46d618d63fdf9bfd7d39e8f264
2023-05-19 06:11:53 -07:00
Nimrod Gileadi 0e1f948c0a Change some redirecting links to direct links.
Files in github should be linked to using /blob/ rather than /tree/ URLs, while directories should be linked with /tree/.

PiperOrigin-RevId: 524796430
Change-Id: I72492a6acde0709b55d8d8620ad9b538619e7606
2023-04-17 03:06:06 -07:00
Nimrod Gileadi d7844aa5be Fix links to documentation.
1. Links to the programming chapter were broken after 69c74f850e. They're now fixed with a redirect in readthedocs.io, but this commit updates them to the latest URL.

2. Most docs links should point to "stable" instead of "latest", since most users will want the docs for the released version, not the upcoming version. The exceptions are the programming chapter, and instructions for building the Python bindings from source.

PiperOrigin-RevId: 502821526
Change-Id: If0a55ab2be4751ba0165bf644030464234083133
2023-01-18 02:55:41 -08:00
Saran Tunyasuvunakool 58b623ae5c Update README badge URL.
https://github.com/badges/shields/issues/8671

PiperOrigin-RevId: 495835738
Change-Id: I92199979b30b3f5ba90c5da82faf3bcb0967f461
2022-12-16 03:57:48 -08:00
Saran Tunyasuvunakool 66cb7d611b Remove mujoco-py from the list of bindings advertised in README.
Also make the mention of Python bindings and Unity plugin in the intro section more prominent by breaking it into a separate paragraph.

PiperOrigin-RevId: 492686331
Change-Id: I7ff04219e29d0bd2051c4f218e59aca1639237b7
2022-12-03 07:14:16 -08:00
Kyle Bayes 5a8e861152 Add MuJoCo tutorial Colab using the native Python bindings.
PiperOrigin-RevId: 491424124
Change-Id: I5bdeb68fd1bd1b4bc92fb40e0b876d9dcfc568cb
2022-11-28 13:09:51 -08:00
Saran Tunyasuvunakool 00576a3bf9 Update icons to match the new banner and add Windows version info.
Also update the README banner so that the background grid lines scale more reliably to different screen PPI.

PiperOrigin-RevId: 473598837
Change-Id: I43434b35333714922128f8fd625aa6eb62521a7f
2022-09-11 11:04:36 -07:00
Saran Tunyasuvunakool f55a9fccea Add a MuJoCo banner to the README.
PiperOrigin-RevId: 472721942
Change-Id: Ida552f8ffe6ead102d138586c3e280a543c97511
2022-09-07 07:43:26 -07:00
Kevin Zakka e96776c901 Add documentation badge to README.
PiperOrigin-RevId: 465791060
Change-Id: I7d1266bea1b4d59f6ff7f112f35f14f2a62282b1
2022-08-06 13:58:03 -07:00
Yuval Tassa d5059f484d Add license badge to README.
PiperOrigin-RevId: 460437521
Change-Id: I25514343a6b0f507c661261a20d1ad07465491fc
2022-07-12 05:40:28 -07:00
Kevin Zakka afc8395376 Make installation instructions more explicit in the README.
PiperOrigin-RevId: 456976659
Change-Id: I9bac31771eb62e069107b30122478437b67c2ebf
2022-06-24 03:48:26 -07:00
Yuval Tassa 2ea01bf2f6 Add Related Software section to README.md.
BEGIN PUBLIC

Add Related Software section to README.md.

Fixes #312.

END_PUBLIC

PiperOrigin-RevId: 456528399
Change-Id: Icf97a31a5ea16e93edf9856f70dec650c7b70791
2022-06-22 09:06:43 -07:00
Yuval Tassa 8958e13878 Improve best-practice description of included models in GitHub issues.
PiperOrigin-RevId: 455060429
Change-Id: I6a4544e99436749590a8d46ada09777ce2e90330
2022-06-15 01:06:15 -07:00
Yuval Tassa 8e38a8a020 Add "Asking Questions" section to README.md
PiperOrigin-RevId: 453178202
Change-Id: I0cb3a52983930fb3665cc40e26d5d19b44ac99f1
2022-06-06 05:23:55 -07:00
Nimrod Gileadi 0741273c86 Typo in README.md.
PiperOrigin-RevId: 451172762
Change-Id: I0254cef6d279a13008f7dcdd358636f30d6d3107
2022-05-26 08:56:56 -07:00
Saran Tunyasuvunakool 98cea58c5e Add a build shield to README.md.
PiperOrigin-RevId: 450490553
Change-Id: I9be149134966f9a744bbbc5810ed22da43f0a586
2022-05-23 11:48:13 -07:00
Kevin Zakka 89d95ad3c7 Nit fixes in README.
PiperOrigin-RevId: 450435777
Change-Id: I8d9c969cce1d16560ca50fbda3704ac808c20477
2022-05-23 07:40:45 -07:00
Saran Tunyasuvunakool 1913a02b40 Initial open sourcing of MuJoCo.
PiperOrigin-RevId: 450374687
Change-Id: Ie3225a46ce095fc28ae8e63c326a640261f562bb
2022-05-23 01:08:49 -07:00
Saran Tunyasuvunakool c669ec35cf Update README.md and CONTRIBUTING.md to reflect the updated repository.
PiperOrigin-RevId: 435166719
Change-Id: I6531008950a7492c5f6c4557b78492cee0fe8822
2022-03-17 14:30:28 +00:00
Yuval Tassa 1ef7ec6dde Documentation improvements for 2.1.1.
- Fix typos and broken links.
- Add documentation for functions introduced in 2.1.1.
- Add copyright header to `FLV.m` and remove `hello.c`.
- Update documentation for `mj_ray` and `mj_contactForce`.
- Delete out-of-date comments in `XMLreference.rst`.
- Add geom:size table to `XMLreference.rst`.

PiperOrigin-RevId: 425318966
2022-01-31 19:19:19 +00:00
Saran Tunyasuvunakool 1f7eaae62e Version 2.1: documentation, public API headers, and sample programs.
PiperOrigin-RevId: 403900419
2021-10-18 12:35:33 +01:00