Update the WASM bindings README
* Removed the caution callout since some internal CI has been implemented. * Added to clarify the state of bindings build process on Windows. * Fixed the formatting of a note callout in the Testing section. PiperOrigin-RevId: 831899135 Change-Id: I9f105b91e924368c8e84da7114e1b1d3e48c185a
This commit is contained in:
committed by
Copybara-Service
parent
b0e75b7103
commit
86ac3a5e28
+3
-16
@@ -1,10 +1,5 @@
|
||||
# MuJoCo JavaScript Bindings
|
||||
|
||||
> [!CAUTION]
|
||||
> **These bindings are not yet ready for general use. They have been added
|
||||
> without announcement while we develop the CI we need to accept pull
|
||||
> requests.**
|
||||
|
||||
These are the canonical JavaScript and TypeScript bindings for the MuJoCo
|
||||
physics engine.
|
||||
|
||||
@@ -19,7 +14,9 @@ TypeScript.
|
||||
> _These bindings are still a WIP. For details, see the [Future Work](#future-work)
|
||||
> section. Also note that development has primarily taken place on Linux using
|
||||
> Google Chrome. If you're working on a different OS or browser, you may
|
||||
> encounter some rough edges._
|
||||
> encounter some rough edges. We have successfully tested the bindings on MacOS
|
||||
> in CI but as of November 13th 2025 Windows in untested (the instructions here
|
||||
> have worked on one Windows 11 machine but have failed on other machines)._
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -141,16 +138,6 @@ bounds checking and nice error reporting.
|
||||
npm run test --prefix ./wasm
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The above command runs the [`enums_tests.ts`](tests/enums_tests.ts) file
|
||||
> which checks that all the enums in the API are bound. This test is
|
||||
> auto-generated so if you add/edit an enum to MuJoCo then you will need to
|
||||
> run the following command to re-create the test:
|
||||
>
|
||||
> ```sh
|
||||
> PYTHONPATH=python/mujoco python3 -m wasm.codegen.tests.enums_test_generator
|
||||
> ```
|
||||
|
||||
2. **JavaScript API benchmark tests.**
|
||||
The current benchmark tests check JavaScript/C++ shared memory buffers
|
||||
performance. We will increase the coverage of the benchmarks overtime. Run
|
||||
|
||||
Reference in New Issue
Block a user