Skip to content

Commit

Permalink
Added a note about target platforms and build requirements.
Browse files Browse the repository at this point in the history
  • Loading branch information
RossNordby committed Apr 1, 2018
1 parent c886cf1 commit a65c1f3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion BepuUtilities/BepuUtilities.csproj
Expand Up @@ -6,7 +6,7 @@
<Version>2.0.0-alpha</Version>
<Company>Bepu Entertainment LLC</Company>
<Authors>Ross Nordby</Authors>
<Description>Early version of BEPUphysics v2.</Description>
<Description>Supporting utilities library for an early version of BEPUphysics v2.</Description>
<Copyright>© Bepu Entertainment LLC</Copyright>
<PackageProjectUrl>https://github.com/bepu/bepuphysics2</PackageProjectUrl>
<PackageLicenseUrl>https://github.com/bepu/bepuphysics2/blob/master/LICENSE.md</PackageLicenseUrl>
Expand Down
12 changes: 11 additions & 1 deletion README.md
Expand Up @@ -4,6 +4,14 @@ This is the repo for the bepuphysics v2 library, a complete rewrite of the C# 3d

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

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.

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).

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.

## Features

The alpha contains a basic featureset:
- Spheres, capsules, boxes
- Simple compounds of the above, mainly for use in smaller shapes where acceleration structures wouldn't be helpful
Expand All @@ -22,6 +30,8 @@ It notably does *not* yet include:
- Shape casts
- Many useful constraint types

## Links

If you are one of the brave early adopters, you can report bugs [here on github](../../issues).

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

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

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

0 comments on commit a65c1f3

Please sign in to comment.