From: Kevin Clark Date: Tue, 24 Jun 2008 01:06:08 +0000 (+0000) Subject: rb: rewrite the README [THRIFT-38] X-Git-Tag: 0.2.0~500 X-Git-Url: https://source.supwisdom.com/gerrit/gitweb?a=commitdiff_plain;h=1b8fec10dbd4513adda091d1ae2b20d1dac017ef;p=common%2Fthrift.git rb: rewrite the README [THRIFT-38] From kevin@rapleaf.com git-svn-id: https://svn.apache.org/repos/asf/incubator/thrift/trunk@670984 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/lib/rb/README b/lib/rb/README index 7e1a1c6d..e78cee29 100644 --- a/lib/rb/README +++ b/lib/rb/README @@ -1,29 +1,30 @@ Thrift Ruby Software Library + by Kevin Ballard, Kevin Clark, Mark Slee + http://incubator.apache.org/thrift/ -Author: Mark Slee (mcslee@facebook.com) -Last Modified: 2007-Mar-05 +== DESCRIPTION: -Thrift is distributed under the Thrift open source software license. -Please see the included LICENSE file. +Thrift is a strongly-typed language-agnostic RPC system. +This library is the ruby implementation for both clients and servers. + +== INSTALL: -Using Thrift with Ruby -====================== + $ gem install thrift -Okay, I'll be honest. I learned Ruby by implementing the Thrift library in -Ruby and writing the code generator at the same time. I am not a trendy -web 2.0 programmer. Shit, I don't even know Rails. So if you care about Ruby -you will probably find that this is currently the least robust Thrift library -implementation. But there's plenty of time to improve it... +== CAVEATS: -The source code for the Ruby library is designed for installation with the -Python-esque setup.rb utility, which is included here and redistributable -under the GPL license. +This library provides the client and server implementations of thrift. +It does not provide the compiler for the .thrift files. To compile +.thrift files into language-specific implementations, please download the full +thrift software package. -To install the Thrift Ruby libraries, become superuser and do: +== USAGE: -ruby setup.rb config -ruby setup.rb setup -ruby setup.rb install +This section should get written by someone with the time and inclination. +In the meantime, look at existing code, such as the benchmark or the tutorial +in the full thrift distribution. -Alternatively, if you know more about Ruby than me, you can improve the build -and installation process and contribute them back to this project. Wicked. +== LICENSE: + +Thrift is distributed under the Apache Software License. +Please see the included LICENSE file.