Oops, fix README
[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 Folly is published on Github at https://github.com/facebook/folly; for
9 discussions, there is a Google group at
10 https://groups.google.com/d/forum/facebook-folly.
11
12 Dependencies
13 ------------
14
15 - double-conversion (http://code.google.com/p/double-conversion/)
16
17     By default, the build tooling for double-conversion does not build
18     any libraries, which folly requires.  To build the necessary libraries
19     copy folly/SConstruct.double-conversion to your double-conversion
20     source directory before building:
21
22       [double-conversion/] scons -f SConstruct.double-conversion
23
24     Then set CPPFLAGS/LDFLAGS so that folly can find your double-conversion
25     build:
26
27       [folly/] LDFLAGS=-L<double-conversion>/ CPPFLAGS=-I<double-conversion>/src/
28         configure ...
29
30 - googletest (Google C++ Testing Framework)
31
32   Grab gtest 1.6.0 from:
33   http://googletest.googlecode.com/files/gtest-1.6.0.zip
34
35   Unzip it inside of the test/ subdirectory.
36
37 - additional platform specific dependencies:
38
39   Ubuntu 12.10 64-bit
40     - g++
41     - automake
42     - autoconf
43     - autoconf-archive
44     - libtool
45     - libboost1.46-all-dev
46     - libgoogle-glog-dev
47     - libgflags-dev
48     - liblz4-dev
49     - liblzma-dev
50     - libsnappy-dev
51     - zlib1g-dev
52     - scons (for double-conversion)
53     - binutils-dev      (optional)
54     - libiberty-dev     (optional)
55     - libjemalloc-dev   (optional)
56  
57   Fedora 17 64-bit
58     - gcc
59     - gcc-c++
60     - autoconf
61     - autoconf-archive
62     - automake
63     - boost-devel
64     - libtool
65     - lz4-devel
66     - lzma-devel
67     - snappy-devel
68     - zlib-devel
69     - glog-devel
70     - gflags-devel
71     - scons (for double-conversion)