add README

master
Evan Hemsley 2019-10-23 17:36:42 -07:00
parent 6b257a9661
commit 4d724c9f1b
1 changed files with 16 additions and 0 deletions

16
README.md Normal file
View File

@ -0,0 +1,16 @@
# MoonTools.Core.Graph
A GC-friendly graph theory library for C# intended for use with games.
## Usage
`Graph` implements the following graph structures:
* Directed
* Directed Weighted
* Directed Weighted Multigraph
* Undirected
## Notes
`Graph` algorithms return lazy enumerators to avoid creating GC pressure. If you wish to hang on to the results of an evaluation, make sure to call `ToArray()` or `ToList()` on the IEnumerable.