From b86349fde74e46968c0a283aaa46acc8d69b6a85 Mon Sep 17 00:00:00 2001 From: Prashant Anantharaman <prashantbarca@users.noreply.github.com> Date: Fri, 9 Sep 2016 10:23:29 -0700 Subject: [PATCH] Add more documentation for Ruby binding --- src/bindings/ruby/README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/src/bindings/ruby/README.md b/src/bindings/ruby/README.md index ae29459f..480f2559 100644 --- a/src/bindings/ruby/README.md +++ b/src/bindings/ruby/README.md @@ -21,12 +21,37 @@ Ruby bindings for [hammer](https://github.com/UpstandingHackers/hammer), a parsi ## Installation -TODO +1. Download the hammer source code, and make it available system wide with the bindings. + + `git clone https://github.com/UpstandingHackers/hammer` + `cd hammer` + + `scons bindings=ruby` + + `sudo scons bindings=ruby install` + +2. On linux, you will have to do + + `sudo ldconfig` + +3. Build the gem + `gem build hammer-parser.gemspec` + +4. Install the gem + `gem install hammer-parser-x.x.x.gem` ## Examples +Add hammer to your Gemfile. + + `gem 'hammer-parser'` + +Use hammer in your project. + + `require 'hammer'` + ### Building a parser ```ruby -- GitLab