Skip to content

Commit

Permalink
Update Readme (#834)
Browse files Browse the repository at this point in the history
  • Loading branch information
atouchet committed Apr 27, 2022
1 parent 71a2466 commit 2d391e9
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Expand Up @@ -2,7 +2,7 @@

[Documentation](https://docs.rs/git2)

libgit2 bindings for Rust
libgit2 bindings for Rust.

```toml
[dependencies]
Expand Down Expand Up @@ -37,23 +37,22 @@ pre-commit hook found [here][pre-commit-hook] and place it into the
`.git/hooks/` with the name `pre-commit`. You may need to add execution
permissions with `chmod +x`.


To skip tests on a simple commit or doc-fixes, use `git commit --no-verify`.

## Building on OSX 10.10+
## Building on macOS 10.10+

If the `ssh` feature is enabled (and it is by default) then this library depends
on libssh2 which depends on OpenSSL. To get OpenSSL working follow the
[`openssl` crate's instructions](https://github.com/sfackler/rust-openssl#macos).
[`openssl` crate's instructions](https://github.com/sfackler/rust-openssl/blob/master/openssl/src/lib.rs#L31).

# License

This project is licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
https://opensource.org/licenses/MIT)

at your option.

Expand Down

0 comments on commit 2d391e9

Please sign in to comment.