Add more documentation for Ruby binding
This commit is contained in:
parent
6068ec9fce
commit
b86349fde7
1 changed files with 26 additions and 1 deletions
|
|
@ -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
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue