1
0
Fork 0
mirror of https://github.com/rubyjs/libv8 synced 2023-03-27 23:21:48 -04:00

add README

This commit is contained in:
Charles Lowell 2011-05-31 10:47:55 -05:00
parent 946a91dd2c
commit 774c889d23

35
README.md Normal file
View file

@ -0,0 +1,35 @@
##libv8
A gem for distributing the v8 runtime libraries and headers in both source and binary form.
### Why?
The goal of libv8 is two fold: provide a binary gem containing the a pre-compiled libv8.a for as many
platforms as possible while at the same time supporting for an automated compilation for all others.
Not only does this drastically reduce gem install times, but it opens the door for supporting Windows.
### Do I Get a Binary?
That depends on your platform. Right now, we support the following platforms.
* x86_64-darwin10.7.0
If you don't see your platform on this list, first, make sure that it installs from source, and second
talk to us about seeting up a binary distro for you.
### What if I can't install from source?
If you can fix the [Makefile](https://github.com/fractaloop/libv8/blob/master/lib/libv8/Makefile) so that it correctly compiles for your platform, we'll pull it right in!
### About
This project spun off of [therubyracer](http://github.com/cowboyd/therubyracer) which depends on having
a specific version of v8 to compile and run against. However, actually delivering that version
reliably to all the different platforms proved to be a challenge to say the least.
We got tired of waiting 5 minutes for v8 to compile every time we installed that gem.