| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 1 | Thrift (Thrift IDL and RPC tool) |
| 2 | Version 1.0 (22 August 2006) |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 3 | |
| 4 | Mark Slee (mcslee@facebook.com) |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 5 | Aditya Agarwal (aditya@facebook.com) |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 6 | Marc Kwiatkowski (marc@facebook.com) |
| 7 | |
| 8 | $Header$ |
| 9 | |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 10 | Thrift is distributed under the Thrift open source software license. |
| 11 | Please see the included LICENSE file. |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 12 | |
| 13 | Introduction |
| 14 | ============ |
| 15 | |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 16 | Thrift is a lightweight, language-independent software stack with an |
| 17 | associated code generation mechanism for RPC. |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 18 | |
| 19 | Requirements |
| 20 | ============ |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 21 | Thrift requires boost shared pointers from boost-1.33.1 or greater, |
| 22 | see http://www.boost.org/libs/smart_ptr/smart_ptr.htm |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 23 | |
| 24 | Resources |
| 25 | ========= |
| 26 | |
| 27 | More information about Thrift can be obtained on the Thrift webpage at: |
| 28 | |
| 29 | http://developers.facebook.com/thrift |
| 30 | |
| 31 | Acknowledgments |
| 32 | =============== |
| 33 | |
| 34 | Thrift was inspired by pillar, a lightweight RPC tool written by Adam D'Angelo |
| 35 | |
| 36 | INSTALLATION |
| 37 | ============ |
| 38 | |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 39 | If you are building from the first time out of the source repository, you will |
| 40 | need to generate the configure scripts. From the top directory, do: |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 41 | |
| 42 | ./bootstrap.sh |
| 43 | |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 44 | Once the configure scripts are generated, thrift can be configured. |
| 45 | From the top directory, do: |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 46 | |
| 47 | ./configure |
| 48 | |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 49 | You may need to specify the location of the boost files explicitly. |
| 50 | If you installed boost in /usr/local, you would run configure as follows: |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 51 | |
| 52 | ./configure --with-boost=/usr/local |
| 53 | |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 54 | Note that by default the thrift C++ library is built with no debugging symbols |
| 55 | included. If you would like debugging symbols during development work, run: |
| Mark Slee | 2905078 | 2006-09-29 00:12:30 +0000 | [diff] [blame] | 56 | |
| Mark Slee | 57cc25e | 2007-02-28 21:43:54 +0000 | [diff] [blame^] | 57 | ./configure CFLAGS='-g -O2' |
| Mark Slee | 2905078 | 2006-09-29 00:12:30 +0000 | [diff] [blame] | 58 | |
| Marc Slemko | 9de5a5c | 2006-08-23 22:34:00 +0000 | [diff] [blame] | 59 | Run ./configure --help to see other configuration options |
| 60 | |
| 61 | Make thrift |
| 62 | |
| 63 | make |
| 64 | |
| 65 | From the top directory, become superuser and do: |
| 66 | |
| 67 | make install |