Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chlewin authored Aug 8, 2024
1 parent a90b017 commit 510e016
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@
[![BSD3 Clause](https://img.shields.io/badge/license-BSD3_Clause-blue.svg)](LICENSE.md)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](VERSION.md)

This package is an accessible WebGPU implementation of Position Based MPM (PB-MPM).
This package is a WebGPU implementation of Position Based MPM (PB-MPM).

<img src="data/blockCrusher.gif"> <img src="data/coiling.gif"> <img src="data/colliders.gif"> <img src="data/splashing.gif">

To see the demo in action, go [here](https://electronicarts.github.io/pbmpm/).


This **Main** branch contains many optimizations that make it harder to understand. For a more accessible version of the code, see the [SIGGRAPH 2024](https://github.com/electronicarts/pbmpm/tree/siggraph2024) branch that is less optimized but more readable.

## Building

PB-MPM is based on WebGPU. Currently, this restricts its use to the Chrome and Edge browsers.
PB-MPM is based on WebGPU. Currently, this means Firefox will not work on desktop browsers.
Some mobile hardware can run WebGPU but this app is not properly mobile-aware so the experience will not be good.

1. [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
1. [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/). If you are on *MacOS*: Please follow [these instructions](https://jekyllrb.com/docs/installation/macos/).
2. Run `bundle install`
3. Run `jekyll serve --livereload`
4. Open a browser window at [`localhost:4000`](http://localhost:4000)
Expand All @@ -36,7 +38,7 @@ Before you can contribute, EA must have a Contributor License Agreement (CLA) on
You can sign here: http://bit.ly/electronic-arts-cla

## Research Resources
- [incremental_mpm](https://github.com/nialltl/incremental_mpm)
- [incremental_mpm](https://github.com/nialltl/incremental_mpm) by nialltl

## License
- The source code is released under a *BSD 3-Clause License* as detailed in [LICENSE.md](LICENSE.md)

0 comments on commit 510e016

Please sign in to comment.