Skip to content

Commit 817c856

Browse files
committed
update readme
1 parent b5a7f00 commit 817c856

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
1-
# fluidsim (wgpu edition)
1+
# fluidsim
22

3-
bevy -> wgpu == decent compile times (finally)
3+
## Online Demo
44

5-
tesselation (aka. circleizer) brought to you by lyon
5+
Note that this project was never supposed to run in the browser. I made the bare minimum possible changes to get it working with WebGPU. Your computer WILL freeze if it does not have enough RAM or CPU.
66

7-
Thank you so much to Sebastian Lague for the gradient and also showing me how
8-
to do stuff.
7+
That being said, visit [fluidsim.angad.page](https://fluidsim.angad.page) to try it out.
98

10-
im gonna make a compute shader for this next (the cpu is soo bad at parallelizing simple stuff lmao)
9+
## Windows
1110

12-
## Demo (Youtube)
11+
Despite my best efforts, this application crashes on my Windows VM. I have only ever gotten it to work on Linux.
1312

14-
[![Ok](https://img.youtube.com/vi/D17G4Rgh_oA/0.jpg)](https://www.youtube.com/watch?v=D17G4Rgh_oA)
13+
That being said, a release binary is available from the [releases page](https://github.com/onlycs/fluidsim/releases). It dynamically links to
14+
15+
- `libvulkan.so.1`
16+
- `libwayland-client.so.0`
17+
- `libxcbcommon.so.0`
18+
19+
So make sure they are available.
20+
21+
## Acknowledgements
22+
23+
- Sebastian Lague for the [YouTube video](https://www.youtube.com/watch?v=rSKMYc1CQHE) that made me think this was a good project idea
24+
- [These](https://matthias-research.github.io/pages/publications/sca03.pdf) [three](https://web.archive.org/web/20250106201614/http://www.ligum.umontreal.ca/Clavet-2005-PVFS/pvfs.pdf) [papers](https://sph-tutorial.physics-simulation.org/pdf/SPH_Tutorial.pdf) from his works cited page
25+
- [These files](https://github.com/SebLague/Fluid-Sim/tree/Episode-01/Assets/Scripts/Sim%202D/Compute) which I used for reference, occasionally.

0 commit comments

Comments
 (0)