Merge pull request #178 from prashantbarca/master
More documentation for ruby bindings
This commit is contained in:
commit
f03db8ee5b
2 changed files with 29 additions and 4 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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'
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue