commit 6e673f1c8640c0999441bd415a39276a6ce172fa parent a5ee491f9ed42a6390d0579f0e735056693087f8 Author: mjkloeckner <martin.cachari@gmail.com> Date: Fri, 27 Jan 2023 18:15:51 -0300 added README.md Diffstat:
| A | README.md | | | 29 | +++++++++++++++++++++++++++++ |
1 file changed, 29 insertions(+), 0 deletions(-) diff --git a/README.md b/README.md @@ -0,0 +1,29 @@ +# Graph implementation in C + + +Simple graph data structure implementation in C using adjacency list. Featuring +graph output to stdout formatted in +[dot language](https://graphviz.org/doc/info/lang.html). + +## Compiling and running + +``` +$ make -j $(nproc) +$ ./main +``` + +## Generating a nice preview of the graph + +First make sure you have [graphiz]() package installed, then just pipe the +output of the program to `dot`: + +``` +$ ./main | dot -T png -o out.png +``` + +this will generate a png file containing a nice representation of the graph. You +can open it with you prefered image viewer. + +## License + +[MIT](https://opensource.org/licenses/MIT)