1= Graph
2
3A graph library with goals of speed and simplicity, Graph implements
4graph algorithms on graphs of zero-based integer node IDs.
5
6image:https://godoc.org/github.com/soniakeys/graph?status.svg[link=https://godoc.org/github.com/soniakeys/graph]
7image:http://gowalker.org/api/v1/badge[link=https://gowalker.org/github.com/soniakeys/graph]
8image:http://go-search.org/badge?id=github.com%2Fsoniakeys%2Fgraph[link=http://go-search.org/view?id=github.com%2Fsoniakeys%2Fgraph]
9image:https://travis-ci.org/soniakeys/graph.svg?branch=master[link=https://travis-ci.org/soniakeys/graph]
10
11The library provides efficient graph representations and many methods on
12graph types.  It can be imported and used directly in many applications that
13require or can benefit from graph algorithms.
14
15The library should also be considered as library of source code that can serve
16as starting material for coding variant or more complex algorithms.
17
18== Ancillary material of interest
19
20The directory link:tutorials[tutorials] is a work in progress - there are only
21a few tutorials there yet - but the concept is to provide some topical
22walk-throughs to supplement godoc.  The source-based godoc documentation
23remains the primary documentation.
24
25The directory link:anecdote[anecdote] contains a stand-alone program that
26performs single runs of a number of methods, collecting one-off or "anecdotal"
27timings.  It currently runs only a small fraction of the library methods but
28may still be of interest for giving a general idea of how fast some methods
29run.
30
31The directory link:bench[bench] is another work in progress.  The concept is
32to present some plots showing benchmark performance approaching some
33theoretical asymptote.
34
35link:hacking.adoc[hacking.adoc] has some information about how the library is
36developed, built, and tested.  It might be of interest if for example you
37plan to fork or contribute to the the repository.
38
39== Test coverage
401 Jul 2017
41....
42graph          93.7%
43graph/alt      88.0%
44graph/dot      77.7%
45graph/treevis  79.4%
46....
47
48== License
49All files in the repository are licensed with the MIT License,
50https://opensource.org/licenses/MIT.
51