| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 1 | Thrift (Thrift IDL and RPC tool) Version 1.0 (22 August 2006) |
| 2 | |
| 3 | Mark Slee (mcslee@facebook.com) |
| 4 | Marc Kwiatkowski (marc@facebook.com) |
| 5 | |
| 6 | $Header$ |
| 7 | |
| Mark Slee | 1b87070 | 2006-10-25 19:58:06 +0000 | [diff] [blame] | 8 | Copyright (c) 2006, Facebook, Inc. |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 9 | All rights reserved. |
| 10 | |
| 11 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: |
| 12 | |
| 13 | * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. |
| 14 | * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. |
| 15 | * Neither the name of Facebook, inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. |
| 16 | |
| 17 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 18 | Copyright (C) 2001-2006 Facebook |
| 19 | |
| 20 | Introduction |
| 21 | ============ |
| 22 | |
| 23 | Thrift is a lightweight, language-independent RPC mechanism. |
| 24 | |
| 25 | Requirements |
| 26 | ============ |
| 27 | Thrift requires Python 2.4 or greater and PLY, the python LALR generator tool, 1.7 or greater. |
| 28 | See python.org for source and binary distributions for python |
| 29 | See http://www.dabeaz.com/ply/ply.html for the PLY distribution and documentation |
| 30 | |
| 31 | Thrift requires boost shared pointers from boost-1.33.1 or greater, see http://www.boost.org/libs/smart_ptr/smart_ptr.htm |
| 32 | |
| 33 | Resources |
| 34 | ========= |
| 35 | |
| 36 | More information about Thrift can be obtained on the Thrift webpage at: |
| 37 | |
| 38 | http://developers.facebook.com/thrift |
| 39 | |
| 40 | Acknowledgments |
| 41 | =============== |
| 42 | |
| 43 | Thrift was inspired by pillar, a lightweight RPC tool written by Adam D'Angelo |
| 44 | |
| 45 | INSTALLATION |
| 46 | ============ |
| 47 | |
| 48 | If you are building from the first time out of the source repository, you will need to generate the configure scripts. From the top directory, do: |
| 49 | |
| 50 | ./bootstrap.sh |
| 51 | |
| 52 | Once the configure scripts are generated, thrift can be configured. From the top directory, do: |
| 53 | |
| 54 | ./configure |
| 55 | |
| 56 | You may need to specify the locacation of the boost files explicitly: If you installed boost in /usr/local, you would run configure as follows: |
| 57 | |
| 58 | ./configure --with-boost=/usr/local |
| 59 | |
| Mark Slee | 2905078 | 2006-09-29 00:12:30 +0000 | [diff] [blame] | 60 | Note that by default the thrift C++ library is built with no debugging symbols included. If you would like debugging symbols during development work, run: |
| 61 | |
| 62 | ./configure --CFLAGS='-g -O2' |
| 63 | |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 64 | Run ./configure --help to see other configuration options |
| 65 | |
| 66 | Make thrift |
| 67 | |
| 68 | make |
| 69 | |
| 70 | From the top directory, become superuser and do: |
| 71 | |
| 72 | make install |
| 73 | |
| 74 | |