From 924bdbfe86d1df682e392856f9d68d61fcb5c55f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Wed, 3 Jan 2024 22:15:25 +0200 Subject: [PATCH] Update crate docs --- README.md | 8 ++++---- src/lib.rs | 14 +++++++++----- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 57de75ba3..f7493bc16 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Documentation](https://docs.rs/gdal/badge.svg)](https://docs.rs/gdal) ![Build Status](https://github.com/georust/gdal/workflows/CI/badge.svg) -[GDAL](http://gdal.org/) is a translator and processing library for various raster and vector geospatial data formats. +[GDAL](http://gdal.org/) is a translator and processing library for various raster and vector geospatial data formats. This crate provides safe, idiomatic [Rust](http://www.rust-lang.org/) bindings for GDAL. @@ -20,9 +20,9 @@ GDAL is an incredibly powerful library. For a general understanding of its capab ## Documentation -This crate's [API documentation](https://docs.rs/crate/gdal) is hosted on [docs.rs](https://docs.rs). +This crate's [API documentation](https://docs.rs/crate/gdal) is hosted on [docs.rs](https://docs.rs). -The Rust documentation is currently a work in progress, and may not cover requisite details on parameter semantics, value interpretation, etc. +The Rust documentation is currently a work in progress, and may not cover requisite details on parameter semantics, value interpretation, etc. Therefore, the authoritative documentation is that of GDAL in the form of its [C](https://gdal.org/api/index.html#c-api) and [C++](https://gdal.org/api/index.html#id3) APIs. The former is technically what this crate calls, but the latter is usually more clear and better documented. @@ -39,7 +39,7 @@ As a general rule, only GDAL versions in Ubuntu LTS-1 (previous LTS version, tha Building this crate assumes a compatible version of GDAL is installed with the corresponding header files and shared libraries. This repository includes pre-generated bindings for GDAL 3.0 through 3.8 (see the`gdal-sys/prebuilt-bindings` directory). -If you're compiling against another version of GDAL, you can enable the `bindgen` feature flag to have the bindings generated on the fly. +If you're compiling against another version of GDAL, you can enable the `bindgen` feature flag to have the bindings generated on the fly. ## Community diff --git a/src/lib.rs b/src/lib.rs index e4c67bf05..337c65b3a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,13 +25,17 @@ //! ## Usage //! //! This crate provides high-level, idiomatic Rust bindings for GDAL. -//! To do that, it uses [`gdal_sys`] internally, a low-level interface to the GDAL C library, -//! which is generated using [`bindgen`](https://rust-lang.github.io/rust-bindgen/). -//! Using the `gdal-sys` crate directly is normally not needed, but it can be useful in order to call APIs that have not yet been exposed in this crate. +//! To do that, it uses [`gdal-sys`](gdal-sys) internally, a low-level interface to the GDAL C library, which is generated using [`bindgen`](https://rust-lang.github.io/rust-bindgen/). +//! Using the `gdal-sys` crate directly is normally not needed, but it can be useful in order to call APIs that have not yet been exposed in `gdal`. +//! +//! ## Version support +//! +//! As a general rule, only GDAL versions in Ubuntu LTS-1 (previous LTS version, that is, GDAL 3.0 in 20.04 at this moment) are supported. +//! `gdal-sys` might support earlier versions using the `bindgen` feature flag, but `gdal` does not. //! //! Building this crate assumes a compatible version of GDAL is installed with the corresponding header files and shared libraries. -//! This repository includes pre-generated bindings for GDAL 2.4 through 3.5 (see the`gdal-sys/prebuilt-bindings` directory). -//! If you're compiling against a later version of GDAL, you can enable the `bindgen` feature flag to have new bindings generated on the fly. +//! This repository includes pre-generated bindings for GDAL 3.0 through 3.8 (see the`gdal-sys/prebuilt-bindings` directory). +//! If you're compiling against another version of GDAL, you can enable the `bindgen` feature flag to have the bindings generated on the fly. //! //! ## Show Me Code! //!