emileclarkb/hammer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #178 from prashantbarca/master

Browse source 
More documentation for ruby bindings
This commit is contained in:
Meredith L. Patterson 2016-09-11 11:02:57 +02:00 • committed by GitHub
commit f03db8ee5b
2 changed files with 29 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

27
src/bindings/ruby/README.md
View file

@ -21,12 +21,37 @@ Ruby bindings for [hammer](https://github.com/UpstandingHackers/hammer), a parsi
## Installation ## 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 ## Examples
Add hammer to your Gemfile.
`gem 'hammer-parser'`
Use hammer in your project.
`require 'hammer'`
### Building a parser ### Building a parser
```ruby ```ruby

6
src/bindings/ruby/hammer-parser.gemspec
View file

@ -5,9 +5,9 @@ Gem::Specification.new do |s|
s.summary = 'Ruby bindings to the hammer parsing library.' s.summary = 'Ruby bindings to the hammer parsing library.'
s.description = s.summary # TODO: longer description? s.description = s.summary # TODO: longer description?
s.authors = ['Meredith L. Patterson', 'TQ Hirsch', 'Jakob Rath'] s.authors = ['Meredith L. Patterson', 'TQ Hirsch', 'Jakob Rath']
# TODO: s.email = 'hammer@upstandinghackers.com'
# s.email = ... s.homepage = 'https://github.com/UpstandingHackers/hammer'
# s.homepage = ... s.license = 'GPL-2.0'
files = [] files = []
files << 'README.md' files << 'README.md'