summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2015-01-13 07:53:42 -0800
committerAlex Crichton <alex@alexcrichton.com>2015-01-13 08:22:00 -0800
commit68fe98bde28835af78a1bd87d10fdcb1698d4e5f (patch)
treed8ae9824ad281adc99665a175c40b6e3139b1b44 /README.md
downloadrust-libc-68fe98bde28835af78a1bd87d10fdcb1698d4e5f.tar.gz
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..3a0cc20cf6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+libc
+====
+
+A Rust library with native bindings to the types and functions commonly found on
+various systems, including libc.
+
+[![Build Status](https://travis-ci.org/rust-lang/libc.svg?branch=master)](https://travis-ci.org/rust-lang/libc)
+
+[Documentation](http://doc.rust-lang.org/libc)
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+
+libc = "0.1"
+```
+
+and this to your crate root:
+
+```rust
+extern crate libc;
+```