From 4d724c9f1bf3e12555126661ed0e6cf277de23df Mon Sep 17 00:00:00 2001 From: Evan Hemsley Date: Wed, 23 Oct 2019 17:36:42 -0700 Subject: [PATCH] add README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cb13097 --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file