diff --git a/README.md b/README.md index e8b0035..ecc79c6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # gcc-rs +A library to compile C/C++ code into a Rust library/application. + [![Build Status](https://travis-ci.org/alexcrichton/gcc-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/gcc-rs) [![Build status](https://ci.appveyor.com/api/projects/status/onu270iw98h81nwv?svg=true)](https://ci.appveyor.com/project/alexcrichton/gcc-rs) [Documentation](http://alexcrichton.com/gcc-rs) A simple library meant to be used as a build dependency with Cargo packages in -order to build a set of C files into a static archive. +order to build a set of C/C++ files into a static archive. Note that while this +crate is called "gcc", it actually calls out to the most relevant compile for +a platform, for example using `cl` on MSVC. That is, this crate does indeed work +on MSVC! ## Using gcc-rs @@ -15,9 +20,7 @@ also add this crate to your `Cargo.toml` via: ```toml [package] - # ... - build = "build.rs" [build-dependencies]