Skip to content

Commit a65c1f3

Browse files
committed
Added a note about target platforms and build requirements.
1 parent c886cf1 commit a65c1f3

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

BepuUtilities/BepuUtilities.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<Version>2.0.0-alpha</Version>
77
<Company>Bepu Entertainment LLC</Company>
88
<Authors>Ross Nordby</Authors>
9-
<Description>Early version of BEPUphysics v2.</Description>
9+
<Description>Supporting utilities library for an early version of BEPUphysics v2.</Description>
1010
<Copyright>© Bepu Entertainment LLC</Copyright>
1111
<PackageProjectUrl>https://github.com/bepu/bepuphysics2</PackageProjectUrl>
1212
<PackageLicenseUrl>https://github.com/bepu/bepuphysics2/blob/master/LICENSE.md</PackageLicenseUrl>

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ This is the repo for the bepuphysics v2 library, a complete rewrite of the C# 3d
44

55
The library is still in alpha. Many important features are missing, and many bugs likely remain.
66

7+
The BepuPhysics and BepuUtilities libraries target .NET Standard 2.0 and should work on any supported platform. The demos are built on .NET Core 2.0 and require DX11.
8+
9+
The physics engine heavily uses System.Numerics.Vectors types, so to get good performance, you'll need a compiler which can consume those types (like RyuJIT).
10+
11+
To build the source, you'll need a recent version of Visual Studio with the .NET Core workload installed. Demos.sln references all relevant projects.
12+
13+
## Features
14+
715
The alpha contains a basic featureset:
816
- Spheres, capsules, boxes
917
- Simple compounds of the above, mainly for use in smaller shapes where acceleration structures wouldn't be helpful
@@ -22,6 +30,8 @@ It notably does *not* yet include:
2230
- Shape casts
2331
- Many useful constraint types
2432

33+
## Links
34+
2535
If you are one of the brave early adopters, you can report bugs [here on github](../../issues).
2636

2737
Visit the [forums](https://forum.bepuentertainment.com) for discussion and questions.
@@ -40,4 +50,4 @@ There exists some sparse proto-documentation:
4050

4151
If you have too many dollars, we are willing to consume them on [patreon](https://www.patreon.com/bepu).
4252

43-
![](https://raw.githubusercontent.com/bepu/bepuphysics1/master/Documentation/images/readme/angelduck.png)
53+
![](https://raw.githubusercontent.com/bepu/bepuphysics1/master/Documentation/images/readme/angelduck.png)

0 commit comments

Comments
 (0)