Skip to content

Commit

Permalink
README: typo fixes and add contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
dnaeon committed Apr 21, 2024
1 parent 1b65f2a commit 8820388
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 8820388

Please sign in to comment.