From ac9204ea093ff50658805ebf6282f69b089dfcbb Mon Sep 17 00:00:00 2001 From: Thorsten Blum Date: Mon, 29 Jan 2024 19:05:58 +0100 Subject: [PATCH] Update README.md --- README.md | 4 +++- src/lib.rs | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c481267..d671192 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/lib.rs b/src/lib.rs index 51e52cc..1e13d3a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] #![allow(non_camel_case_types)] #[cfg(feature = "buildtime-bindgen")]