Skip to content

Commit

Permalink
add readme and move old one
Browse files Browse the repository at this point in the history
  • Loading branch information
cldwalker committed Apr 2, 2012
1 parent 73368bc commit 6decf9b
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
File renamed without changes.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Description
Fork of [ruby\_core\_source](https://github.com/mark-moseley/ruby_core_source)
that uses included Ruby headers (\*.h and \*.inc) instead of downloading
them. Used by [debugger](http://github.com/cldwalker/debugger).

##Usage

Example use in extconf.rb:

```ruby
require 'ruby_core_source'
hdrs = proc { have_header("vm_core.h") and have_header("iseq.h") }
dir_config("ruby") # allow user to pass in non-standard core include directory
if !Ruby_core_source::create_makefile_with_core(hdrs, "foo")
# error
exit(1)
end
```

To add another ruby version's source to this gem's directory:

$ rake add_source VERSION=1.9.3-p0

## LICENSE
Ruby library code is MIT license, see LICENSE. Included ruby headers,
lib/debugger/ruby\_core\_source/, are mostly Ruby license, see RUBY\_LICENSE. Some headers have
their own licenses, see LEGAL.

0 comments on commit 6decf9b

Please sign in to comment.