protobuf/ruby/README.md

This directory contains the Ruby extension that implements Protocol Buffers functionality in Ruby.

The Ruby extension makes use of generated Ruby code that defines message and enum types in a Ruby DSL. You may write definitions in this DSL directly, but we recommend using protoc's Ruby generation support with .proto files. The build process in this directory only installs the extension; you need to install protoc as well to have Ruby code generation functionality.

Installation

To build this Ruby extension, you will need:

• Rake
• Bundler
• Ruby development headers
• a C compiler

First, install the required Ruby gems:

$ sudo gem install bundler rake rake-compiler rspec rubygems-tasks

Then build the Gem:

$ rake gem
$ gem install pkg/protobuf-$VERSION.gem

This gem includes the upb parsing and serialization library as a single-file amalgamation. It is up-to-date with upb git commit 535bc2fe2f2b467f59347ffc9449e11e47791257.