From 88203888630576f7ba8a253a0c1c969afe03fd06 Mon Sep 17 00:00:00 2001 From: Marin Atanasov Nikolov Date: Sun, 21 Apr 2024 13:39:58 +0300 Subject: [PATCH] README: typo fixes and add `contributing` section --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cda4abc..731649d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ graph representing the relationships between the discovered Makefile targets. ## Installation -You can install the the CLI application using one of the following ways. +You can install the CLI application using one of the following ways. If you have cloned the repository you can build the CLI app using the provided Makefile target. @@ -134,7 +134,7 @@ This is what the resulting graph looks like. ![Example Makefile Graph Related Only](./images/image-3.svg) The `--direction` option is used for specifying the [direction of graph -layout](https://graphviz.org/docs/attrs/rankdir/). You can set it `TB`, `BT`, +layout](https://graphviz.org/docs/attrs/rankdir/). You can set it to `TB`, `BT`, `LR` or `RL`. The `--format` option is used for specifying the output format for the graph. By @@ -177,6 +177,13 @@ Run test coverage. make test-cover ``` +## Contributing + +`makefile-graph` is hosted on +[Github](https://pkg.go.dev/github.com/dnaeon/makefile-graph). Please contribute +by reporting issues, suggesting features or by sending patches using pull +requests. + ## License `makefile-graph` is Open Source and licensed under the [BSD