Skip to content

Commit

Permalink
modify ReadMe to be similar style as other repos
Browse files Browse the repository at this point in the history
  • Loading branch information
Ke-Wang1017 committed Jun 5, 2024
1 parent af13859 commit 8ecc6a6
Showing 1 changed file with 11 additions and 30 deletions.
41 changes: 11 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,29 @@
<p align="center">
<a href="https://zalo.github.io/mujoco_wasm/"><img src="./examples/MuJoCoWasmLogo.png" href></a>
</p>
<p align="left">
<a href="https://github.com/zalo/mujoco_wasm/deployments/activity_log?environment=github-pages">
<img src="https://img.shields.io/github/deployments/zalo/mujoco_wasm/github-pages?label=Github%20Pages%20Deployment" title="Github Pages Deployment"></a>
<!--<a href="https://github.com/zalo/mujoco_wasm/deployments/activity_log?environment=Production">
<img src="https://img.shields.io/github/deployments/zalo/mujoco_wasm/Production?label=Vercel%20Deployment" title="Vercel Deployment"></a> -->
<!--<a href="https://lgtm.com/projects/g/zalo/mujoco_wasm/context:javascript">
<img alt="Language grade: JavaScript" src="https://img.shields.io/lgtm/grade/javascript/g/zalo/mujoco_wasm.svg?logo=lgtm&logoWidth=18"/></a> -->
<a href="https://github.com/zalo/mujoco_wasm/commits/main">
<img src="https://img.shields.io/github/last-commit/zalo/mujoco_wasm" title="Last Commit Date"></a>
<a href="https://github.com/zalo/mujoco_wasm/blob/main/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-brightgreen" title="License: MIT"></a>
</p>

<div align="center">

[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/kscalelabs/ksim/blob/main/LICENSE)
[![Discord](https://img.shields.io/discord/1224056091017478166)](https://discord.gg/k5mSvCkYQh)
[![Wiki](https://img.shields.io/badge/wiki-humanoids-black)](https://humanoids.wiki)

</div>

## The Power of MuJoCo in your Browser.

Load and Run MuJoCo 2.3.1 Models using JavaScript and WebAssembly.

This repo is a fork of @stillonearth 's starter repository, adding tons of functionality and a comprehensive example scene.
This repo is a fork of @zalo 's starter repository, adding tons of functionality and stompy robot scene from kscale labs.


### [See the Live Demo Here](https://zalo.github.io/mujoco_wasm/)

### [See a more Advanced Example Here](https://kzakka.com/robopianist/)

## Building

**1. Install emscripten**

**2. Build the mujoco_wasm Binary**

On Linux, use:
```bash
mkdir build
cd build
emcmake cmake ..
make
```

On Windows, run `build_windows.bat`.

*3. (Optional) Update MuJoCo libs*

Build MuJoCo libs with wasm target and place to lib. Currently v2.3.1 included.
### [See the wiki page Here](https://humanoids.wiki/w/MuJoCo_WASM)

## JavaScript API

Expand Down

0 comments on commit 8ecc6a6

Please sign in to comment.