Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
toblux committed Jan 29, 2024
1 parent 3e07e55 commit ac9204e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ The safe Rust bindings to `libeditorconfig`, built on top of this `editorconfig-

## Dependencies

To use this crate, `libeditorconfig >= 0.12.5` must be installed and `pkg-config` must be able to find it. You can check if `pkg-config` can find the library and which version is installed with:
To use this crate, `pkg-config` and `libeditorconfig >=0.12.5 <1.0.0` must be installed. For example, on Debian or Ubuntu you could use `apt-get install pkg-config libeditorconfig-dev` and on macOS `brew install pkg-config editorconfig` to install the dependencies.

You can check if `pkg-config` can find the library and which version is installed with:

```sh
pkg-config --modversion editorconfig
Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![doc = include_str!("../README.md")]
#![allow(non_camel_case_types)]

#[cfg(feature = "buildtime-bindgen")]
Expand Down

0 comments on commit ac9204e

Please sign in to comment.