Skip to content

Commit 6191271

Browse files
committed
Update readme, mention nuget
1 parent 60dcecd commit 6191271

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,11 @@ C# implementation of generating a Voronoi diagram from a set of points in a plan
66

77
![voronoi example](https://user-images.githubusercontent.com/3857299/213494520-4295378c-9759-4864-aeb7-4cd032b0f3d0.png)
88

9-
The key differences from the [original VoronoiLib repo](https://github.com/Zalgo2462/VoronoiLib)
10-
* Borders can be closed, that is, edges generated along the boundary
11-
* Edges and points/sites contain additional useful data
12-
* Multiple critical and annoyingly-rare bugs and edge cases fixes
13-
* LOTS more unit testing
9+
# Installation
1410

15-
Known issues:
16-
* The algorithm uses a lot of allocations, forcing garbage collection
17-
18-
# Examples
11+
The library is available as `SharpVoronoiLib` [NuGet package](https://www.nuget.org/packages/SharpVoronoiLib): `dotnet add package SharpVoronoiLib` via CLI or via your preferred NuGet package manager.
1912

20-
TODO: several pretty pictures here
13+
Alternatively, you can download the solution and either copy the `SharpVoronoiLib` project code or build the project and use the `SharpVoronoiLib.dll`.
2114

2215
# Use
2316

@@ -104,15 +97,25 @@ List<VoronoiEdge> edges = plane.Relax();
10497

10598
# MonoGame example
10699

107-
A very simple MonoGame example is included in `MonoGameExample` project:
100+
A very simple [MonoGame](https://github.com/MonoGame/MonoGame) example is included in `MonoGameExample` project:
108101

109102
![SVL MG](https://github.com/user-attachments/assets/28dfb592-f6b1-4044-96a9-e32110c237a0)
110103

111-
112104
# Dependencies
113105

114106
The main library is compiled for .NET 8.0 and .NET Standard 2.0 and targets compatible OSes - Windows, Linux & macOS - and .NET and Mono frameworks - Xamarin, Mono, UWP, Unity, etc.
115107

108+
# Original library
109+
110+
The key differences from the [original VoronoiLib repo](https://github.com/Zalgo2462/VoronoiLib):
111+
* Borders can be closed, that is, edges generated along the boundary
112+
* Edges and points/sites contain additional useful data
113+
* Multiple critical and annoyingly-rare bugs and edge cases fixes
114+
* LOTS more unit testing
115+
116+
Known issues:
117+
* The algorithm uses a lot of allocations, forcing garbage collection
118+
116119
# Credits
117120

118121
- [Originally written by Logan Lembke as VoronoiLib](https://github.com/Zalgo2462/VoronoiLib)

0 commit comments

Comments
 (0)