Skip to content

Commit 6decf9b

Browse files
committed
add readme and move old one
1 parent 73368bc commit 6decf9b

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README OLD_README

File renamed without changes.

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Description
2+
Fork of [ruby\_core\_source](https://github.com/mark-moseley/ruby_core_source)
3+
that uses included Ruby headers (\*.h and \*.inc) instead of downloading
4+
them. Used by [debugger](http://github.com/cldwalker/debugger).
5+
6+
##Usage
7+
8+
Example use in extconf.rb:
9+
10+
```ruby
11+
require 'ruby_core_source'
12+
hdrs = proc { have_header("vm_core.h") and have_header("iseq.h") }
13+
dir_config("ruby") # allow user to pass in non-standard core include directory
14+
if !Ruby_core_source::create_makefile_with_core(hdrs, "foo")
15+
# error
16+
exit(1)
17+
end
18+
```
19+
20+
To add another ruby version's source to this gem's directory:
21+
22+
$ rake add_source VERSION=1.9.3-p0
23+
24+
## LICENSE
25+
Ruby library code is MIT license, see LICENSE. Included ruby headers,
26+
lib/debugger/ruby\_core\_source/, are mostly Ruby license, see RUBY\_LICENSE. Some headers have
27+
their own licenses, see LEGAL.

0 commit comments

Comments
 (0)