Skip to content

Commit 28f3bf4

Browse files
committed
task: update readme
1 parent bfd4f5a commit 28f3bf4

1 file changed

Lines changed: 35 additions & 16 deletions

File tree

README.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,42 @@ Ideal for simulations, games, and physics engines requiring reliable arithmetic
2424

2525
## 🚀 Installation
2626

27-
### Via NuGet:
28-
```bash
29-
dotnet add package FixedMathSharp
30-
```
3127

32-
### Testing Locally:
33-
1. Build the package:
34-
```bash
35-
dotnet pack --configuration Release
36-
```
37-
2. Create a local NuGet source and test it:
38-
```bash
39-
mkdir ./LocalNuGet
40-
cp ./bin/Release/*.nupkg ./LocalNuGet/
41-
dotnet nuget add source ./LocalNuGet --name LocalNuGet
42-
dotnet add package FixedMathSharp --source ./LocalNuGet
43-
```
28+
Clone the repository and add it to your project:
29+
30+
### Non-Unity Projects
31+
32+
1. **Install via NuGet**:
33+
- Add FixedMathSharp to your project using the following command:
34+
35+
```bash
36+
dotnet add package FixedMathSharp
37+
```
38+
39+
2. **Or Download/Clone**:
40+
- Clone the repository or download the source code.
41+
42+
```bash
43+
git clone https://github.com/mrdav30/FixedMathSharp.git
44+
```
45+
46+
3. **Add to Project**:
47+
48+
- Include the FixedMathSharp project or its DLLs in your build process.
49+
50+
### Unity
51+
52+
To integrate **FixedMathSharp** into your Unity project:
53+
54+
1. **Download the Package**:
55+
- Obtain the latest `FixedMathSharp{{VERSION}}.unitypackage` from the [Releases](https://github.com/mrdav30/FixedMathSharp/releases) section of the repository.
56+
57+
2. **Import into Unity**:
58+
- In Unity, navigate to **Assets > Import Package > Custom Package...**.
59+
- Select the downloaded `FixedMathSharp{{VERSION}}.unitypackage` file.
60+
61+
3. **Verify the Integration**:
62+
- After importing, confirm that the `FixedMathSharp` namespace is accessible in your scripts.
4463

4564
---
4665

0 commit comments

Comments
 (0)