Skip to content
This repository has been archived by the owner on Oct 8, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lithiumtoast committed Aug 7, 2023
1 parent fdcd792 commit bb9d48c
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,28 @@ Automatically updated C# bindings for https://github.com/SanderMertens/flecs wit

## How to use

### NuGet

NuGet packages are experimental; please add the NuGet feed `https://www.myget.org/F/bottlenoselabs/api/v3/index.json` to access the NuGet packages.

Either install `flecs_hub.Flecs` or `flecs_hub.Interop.Flecs` along with one the native library packages for your operating system / hardware.

|Package name|Description|
|-|-|
|`flecs_hub.Flecs`|High-level, safe, idomatic C# API.|
|`flecs_hub.Interop.Flecs`|Low-level, unsafe, 1-1 C# bindings.|
|`flecs_hub.Interop.Flecs.runtime.win-x64`|Native libraries for Windows x64.|
|`flecs_hub.Interop.Flecs.runtime.osx`|Native libraries for macOS universal (x64 and arm64).|
|`flecs_hub.Interop.Flecs.runtime.linux-x64`|Native libraries for Linux x64.|

### From source

1. Download and install [.NET 7](https://dotnet.microsoft.com/download).
2. Fork the repository using GitHub or clone the repository manually with submodules: `git clone --recurse-submodules https://github.com/flecs-hub/flecs-cs`.
3. Build the native library by running `library.sh`. To execute `.sh` scripts on Windows, use Git Bash which can be installed with Git itself: https://git-scm.com/download/win. The `library.sh` script requires that CMake is installed and in your path and that [`C2CS`](https://github.com/bottlenoselabs/c2cs) is installed.
4.
- .NET 7+: Add the `src/cs/production/Flecs.Core/Flecs.Core.csproj` C# project to your solution as an existing project and then reference it within your own solution.
- Unity: Build the `src/cs/production/Flecs.Unity/Flecs.Unity.csproj` C# project and create the resulting `Flecs.Unity.dll`; follow Unity's documentation for using the compiled C# code as a `.dll`: https://docs.unity3d.com/Manual/UsingDLL.
- Unity: Build the `src/cs/production/Flecs.Unity/Flecs.Unity.csproj` C# project and create the resulting `Flecs.Unity.dll` with it's dependencies; follow Unity's documentation for using the compiled C# code as a `.dll`: https://docs.unity3d.com/Manual/UsingDLL.

## Developers: Documentation

Expand Down

0 comments on commit bb9d48c

Please sign in to comment.