Move LICENCE and README to top level directory
[folly.git] / README
1 Folly: Facebook Open-source LibrarY
2 -----------------------------------
3
4 Folly is an open-source C++ library developed and used at Facebook.
5
6 For details, see folly/docs/Overview.md.
7
8 Dependencies
9 ------------
10
11 - double-conversion (http://code.google.com/p/double-conversion/)
12
13     By default, the build tooling for double-conversion does not build
14     any libraries, which folly requires.  To build the necessary libraries
15     copy folly/SConstruct.double-conversion to your double-conversion
16     source directory before building:
17
18       [double-conversion/] scons -f SConstruct.double-conversion
19
20     Then set CPPFLAGS/LDFLAGS so that folly can find your double-conversion
21     build:
22
23       [folly/] LDFLAGS=-L<double-conversion>/ CPPFLAGS=-I<double-conversion>/src/
24         configure ...
25
26 - googletest (Google C++ Testing Framework)
27
28   Grab gtest 1.6.0 from:
29   http://googletest.googlecode.com/files/gtest-1.6.0.zip
30
31   Unzip it inside of the test/ subdirectory.
32
33 - additional platform specific dependencies:
34
35   Ubuntu 12.04 64-bit
36     - g++
37     - automake
38     - autoconf
39     - libtool
40     - libboost1.46-all-dev
41     - libgoogle-glog-dev
42         This package has been removed from 12.04 -- use the one from 11.10
43     - gflags (packages need to be downloaded from below)
44         http://gflags.googlecode.com/files/libgflags-dev_2.0-1_amd64.deb
45         http://gflags.googlecode.com/files/libgflags0_2.0-1_amd64.deb
46     - scons (for double-conversion)
47
48   Fedora 17 64-bit
49     - gcc
50     - gcc-c++
51     - autoconf
52     - automake
53     - boost-devel
54     - libtool
55     - glog-devel
56     - gflags-devel
57     - scons (for double-conversion)