Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dane Springmeyer committed May 22, 2014
1 parent 64f8fb4 commit 20f26ec
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

An alternative to `boost::variant` for C++11.

[![Build Status](https://secure.travis-ci.org/mapbox/variant.svg)](https://travis-ci.org/mapbox/variant)

[![Build status](https://ci.appveyor.com/api/projects/status/eqddcfxlvmt6fkif)](https://ci.appveyor.com/project/springmeyer/variant)

# Depends

- Compiler supporting `-std=c++11`
- Tested with g++-4.7, g++-4.8, and clang++ 3.4
- Tested with g++-4.7, g++-4.8, and clang++ 3.4, Visual C++ Compiler November 2013 CTP

Note: get the VS "CTP" release at http://www.microsoft.com/en-us/download/details.aspx?id=41151

# Usage

Expand All @@ -18,15 +24,19 @@ The tests depend on:
- Boost headers (for benchmarking against `boost::variant`)
- Boost built with `--with-timer` (used for benchmark timing)

Set your boost includes and libs locations and run `make test`:
On Unix systems set your boost includes and libs locations and run `make test`:

export LDFLAGS='-L/opt/boost/lib'
export CXXFLAGS='-I/opt/boost/include'
make test

On windows do:

vcbuild

## Benchmark

Run the benchmark like:
On Unix systems run the benchmark like:

make bench

Expand Down

0 comments on commit 20f26ec

Please sign in to comment.