Skip to content

Commit 515ca6c

Browse files
committed
- added readthedocs link
1 parent aac1806 commit 515ca6c

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PositionBasedDynamics
22

3-
<p align=center><img src="https://github.com/InteractiveComputerGraphics/PositionBasedDynamics/workflows/build-linux/badge.svg">&nbsp;&nbsp; <img src="https://github.com/InteractiveComputerGraphics/PositionBasedDynamics/workflows/build-windows/badge.svg"></p>
3+
<p align=center><img src="https://github.com/InteractiveComputerGraphics/PositionBasedDynamics/workflows/build-linux/badge.svg">&nbsp;&nbsp; <img src="https://github.com/InteractiveComputerGraphics/PositionBasedDynamics/workflows/build-windows/badge.svg">&nbsp;&nbsp; <a href='https://positionbaseddynamics.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/positionbaseddynamics/badge/?version=latest' alt='Documentation Status' /></a></p>
44

55
This library supports the physically-based simulation of mechanical effects. In the last years position-based simulation methods have become popular in the graphics community. In contrast to classical simulation approaches these methods compute the position changes in each simulation step directly, based on the solution of a quasi-static problem. Therefore, position-based approaches are fast, stable and controllable which make them well-suited for use in interactive environments. However, these methods are generally not as accurate as force-based methods but still provide visual plausibility. Hence, the main application areas of position-based simulation are virtual reality, computer games and special effects in movies and commercials.
66

@@ -21,6 +21,12 @@ Furthermore we use our own library:
2121
[https://github.com/InteractiveComputerGraphics/SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH)
2222
* Our new [paper](http://interactive-graphics.de/index.php/research/98-hierarchical-hp-adaptive-signed-distance-fields) about adaptive signed distance fields uses the PositionBasedDynamics library. You can watch the video [here](https://www.youtube.com/watch?v=x_Iq2yM4FcA).
2323

24+
## Documentation
25+
26+
The documentation can be found here:
27+
28+
* [Documentation](https://positionbaseddynamics.readthedocs.io)
29+
2430
## Forum
2531

2632
On our [GitHub discussions](https://github.com/InteractiveComputerGraphics/PositionBasedDynamics/discussions) page you can ask questions, discuss about simulation topics, and share ideas.
@@ -43,11 +49,6 @@ pip install pypbd
4349

4450
These are available for different Python Versions. See also here: [pyPBD](https://pypi.org/project/pyPBD/).
4551

46-
## Documentation
47-
48-
The API documentation can be found here:
49-
50-
http://www.interactive-graphics.de/PositionBasedDynamics/doc/html
5152

5253
## Latest Important Changes
5354

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,5 +121,5 @@ def build_extension(self, ext):
121121
cmdclass=dict(build_ext=CMakeBuild),
122122
packages=find_packages(),
123123
zip_safe=False,
124-
install_requires=['numpy']
124+
install_requires=['numpy', 'pygame', 'pyopengl']
125125
)

0 commit comments

Comments
 (0)