Skip to content

Commit f7d4541

Browse files
committed
Add getting started section to readme
(cherry picked from commit 75a458b)
1 parent 32b82d9 commit f7d4541

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,77 @@
55
<img src="https://raw.githubusercontent.com/dartsim/dart/master/docs/dart_logo_377x107.jpg" alt="DART: Dynamic Animation and Robotics Toolkit">
66
</p>
77

8+
DART (Dynamic Animation and Robotics Toolkit) is an open-source library that
9+
provides data structures and algorithms for kinematic and dynamic applications
10+
in robotics and computer animation. Renowned for its accuracy and stability,
11+
DART utilizes generalized coordinates to represent articulated rigid body
12+
systems and employs Featherstone's Articulated Body Algorithm to compute motion
13+
dynamics.
14+
15+
## Getting Started
16+
17+
DART provides both C++ and Python interfaces, which can be installed using
18+
various package managers. For cross-platform compatibility, we recommend using
19+
Conda or Pixi.
20+
21+
### C++
22+
23+
#### Cross-Platform (Recommended)
24+
25+
Conda:
26+
27+
```shell
28+
conda install -c conda-forge dartsim-cpp
29+
```
30+
31+
Pixi:
32+
33+
```shell
34+
pixi add dartsim-cpp
35+
```
36+
37+
#### Ubuntu (APT)
38+
39+
```shell
40+
sudo apt install libdart-all-dev
41+
```
42+
43+
#### macOS (Homebrew)
44+
45+
```shell
46+
brew install dartsim
47+
```
48+
49+
#### Windows (Vcpkg)
50+
51+
```shell
52+
vcpkg install dartsim:x64-windows
53+
```
54+
55+
### Python
56+
57+
Conda and Pixi are recommended for installing the Python interface. Please note
58+
that the PyPI package is being deprecated to save maintenance efforts—help
59+
wanted!
60+
61+
Conda:
62+
63+
```shell
64+
conda install -c conda-forge dartpy
65+
```
66+
67+
Pixi:
68+
69+
```shell
70+
pixi add dartpy
71+
```
72+
73+
PyPI (deprecated):
74+
75+
```shell
76+
pip install dartpy
77+
```
78+
879
## Documentation
980

1081
For more information on DART, please visit the DART documentation: [English](https://dart.readthedocs.io/) | [한국어](https://dart-ko.readthedocs.io/) (WIP)

0 commit comments

Comments
 (0)