summaryrefslogtreecommitdiff
path: root/qpid/cpp
diff options
context:
space:
mode:
authorDarryl L. Pierce <mcpierce@apache.org>2013-02-07 15:49:46 +0000
committerDarryl L. Pierce <mcpierce@apache.org>2013-02-07 15:49:46 +0000
commit9930147002679ef48067e119976611c3bd2ac7e4 (patch)
tree7dda423cc53b52321f94d6efce055f7de7bb571e /qpid/cpp
parent55c1695b3258092e54554454c35aa52bd646e050 (diff)
downloadqpid-python-9930147002679ef48067e119976611c3bd2ac7e4.tar.gz
QPID-4568: Fixed up the README.rdoc file
Removed extraneous pieces of information, such as the copyright notice and author name. Fixed the instructions for how to generate the Swig wrapper code and build the gem, how to install it and where to find more information. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1443571 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp')
-rw-r--r--qpid/cpp/bindings/qpid/ruby/README.rdoc35
1 files changed, 15 insertions, 20 deletions
diff --git a/qpid/cpp/bindings/qpid/ruby/README.rdoc b/qpid/cpp/bindings/qpid/ruby/README.rdoc
index 90a2fdcf7a..fce87ac3e1 100644
--- a/qpid/cpp/bindings/qpid/ruby/README.rdoc
+++ b/qpid/cpp/bindings/qpid/ruby/README.rdoc
@@ -1,46 +1,41 @@
= Qpid - Ruby language bindings for the Qpid messaging framework.
-Qpid is an cross-platform enterprise messaging system based on the open-source
+Qpid is a cross-platform enterprise messaging system based on the open-source
AMQP protocol.
-Version :: 0.21.0
-
= Links
Documents :: http://qpid.apache.org/
-= Installation
+= Building The Gemfile
+
+== Prerequisites
-You can install Qpid with the following command.
+You need to have the Qpid client libraries installed along with the related
+development files (headers, etc). To install them, please see:
- $ gem install qpid_messaging
+http://cwiki.apache.org/qpid/developer-pages.html
-== Building The Native Code
+== Gemfile Creation
-The Qpid gem requires that you have available the Qpid libraries and
-development header files. To install them, please see:
+Simply type:
-http://cwiki.apache.org/qpid/developer-pages.html
+ $ gem build qpid_messaging.gemspec
-If you are building the gem within the Qpid development environment
-itself, you can specify the location of the Qpid headers and
-libraries with:
+This will produce a gemfile name qpid_messaging-${VERSION}.gem.
-$ ruby extconfig.rb --with-qpid-lib=[path to libqpidclient.so, etc.]
-$ make
+== Installation
-== Examples
+You can install Qpid with the following command:
-Take a look at the integration tests for examples on how to leverage
-the messaging capabilities of Qpid in your Ruby applications.
+ $ gem install qpid_messaging-${VERSION}.gem
== License
Licensed to the Apache Software Foundation (ASF) under one or more
contributor licensing agreements.
-Author:: Darryl L. Pierce (mailto:dpierce@redhat.com)
-Copyright:: Copyright (c) 2011, Red Hat, Inc.
+Author:: Apache Qpid Project
Homepage:: http://qpid.apache.org
License:: Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0.html