diff --git a/src/bindings/ruby/README.md b/src/bindings/ruby/README.md index ae29459f309a7e8121a199200e50a6572b10c5d6..480f25592323435549c619e2bf2985b499f6de4c 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 diff --git a/src/bindings/ruby/hammer-parser.gemspec b/src/bindings/ruby/hammer-parser.gemspec index 18b4db738ad9325526dbdca381d0acf93f112d3c..9a4a616ab8383e0afe2bd5240fd64d2986effcbd 100644 --- a/src/bindings/ruby/hammer-parser.gemspec +++ b/src/bindings/ruby/hammer-parser.gemspec @@ -5,9 +5,9 @@ Gem::Specification.new do |s| s.summary = 'Ruby bindings to the hammer parsing library.' s.description = s.summary # TODO: longer description? s.authors = ['Meredith L. Patterson', 'TQ Hirsch', 'Jakob Rath'] - # TODO: - # s.email = ... - # s.homepage = ... + s.email = 'hammer@upstandinghackers.com' + s.homepage = 'https://github.com/UpstandingHackers/hammer' + s.license = 'GPL-2.0' files = [] files << 'README.md'