summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorgnzlbg <gonzalobg88@gmail.com>2019-02-07 12:03:10 +0100
committergnzlbg <gonzalobg88@gmail.com>2019-02-07 13:44:32 +0100
commitca12725dbfd42ad3026ca9af26a2de6d733bfdb1 (patch)
tree07aa7a72d07ae21b0ae83c2d58087c238122d153 /README.md
parenta17a91cdbf13a43af4e24c0f5498ff6a5e6271c5 (diff)
downloadrust-libc-ca12725dbfd42ad3026ca9af26a2de6d733bfdb1.tar.gz
Document platform support in the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1caab85438..6f04391a22 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,19 @@ Raw FFI bindings to platform libraries like `libc`.
[![Build Status](https://api.cirrus-ci.com/github/rust-lang/libc.svg)](https://cirrus-ci.com/github/rust-lang/libc)
[![Latest version](https://img.shields.io/crates/v/libc.svg)](https://crates.io/crates/libc)
[![Documentation](https://docs.rs/libc/badge.svg)](https://docs.rs/libc)
-![License](https://img.shields.io/crates/l/libc.svg)
+![License](https://img.shields.io/crates/l/libc.svg**
+
+**NOTE:** The minimum supported Rust version is **Rust 1.13.0** . APIs requiring
+newer Rust features are only available on newer Rust versions:
+
+| Feature | Version |
+|-------------------------|---------|
+| `union` | 1.19.0 |
+| `const mem::size_of` | 1.24.0 |
+| `repr(align)` | 1.25.0 |
+| `core::ffi::c_void` | 1.30.0 |
+
+To use `libc` at its fullest, Rust 1.30.0 is required.
## Usage