Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
li3zhen1 authored Oct 18, 2023
1 parent 2458c8f commit 3c9bd22
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ https://github.com/li3zhen1/Grape/assets/45376537/ea1ccea3-5717-4cfe-a696-c89e75
#### Basic Simulation
Grape currently includes 2 packages, `NDTree` and `ForceSimulation`. `NDTree` is a N-dimensional tree data structure, which is used to accelerate the force simulation. `ForceSimulation` is a force simulation library, which is used to simulate the force between nodes in a graph. Both of them are based on SIMD-like data structures.

The package specifically exposes types for 2D and 3D simulation, so you can create a 2D simulation like this:
The package specifically exposes types for 2D and 3D simulation, so you can simply create one by using `Simulation2D` or `Simulation3D`:

```swift
import NDTree
Expand All @@ -80,6 +80,7 @@ sim.createCollideForce(radius: .constant(3))

See [Example](https://github.com/li3zhen1/Grape/tree/main/Examples/ForceDirectedGraphExample) for more details.

<br/>

#### Extensibility

Expand Down

0 comments on commit 3c9bd22

Please sign in to comment.