Skip to content

Commit

Permalink
chore: add contributing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
imrn99 committed Apr 16, 2024
1 parent dae7d63 commit 0607bf4
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,13 @@ The content of each member is described in their respective Rust Doc as well as

## Contributing

Contributions are welcome and accepted as pull requests on [GitHub][GH]. Feel free to use issues to report bugs,
missing documentation or suggest improvements of the project.

Note that a most of the code possess documentation, including private modules / items / sections. You can generate
the complete documentation by using the instructions [above](#usage) and passing the option `--document-private-items`
to `cargo doc`.

[GH]: https://github.com/LIHPC-Computational-Geometry/honeycomb

## License

0 comments on commit 0607bf4

Please sign in to comment.