Merge pull request #67 from sue445/ruby_h2go

Move to _tools/ruby_h2go/

Author: sue445

.gitignore

@@ -20,5 +20,3 @@
 # Go workspace file
 go.work
 go.work.sum
-
-dist/

CONTRIBUTING.md

@@ -10,11 +10,9 @@ To avoid this problem, we need to call the C function without variable-length ar
 See `RbRaise` implementation in [ruby-internal-error.go](ruby-internal-error.go) for details
 
 ### 1. Generate skeleton
-Run `ruby _scripts/dump_ruby_c_functions.rb`
+Run `ruby _tools/ruby_h2go/ruby_h2go.rb`
 
-Executing [`ruby _scripts/dump_ruby_c_functions.rb`](./_scripts/dump_ruby_c_functions.rb) will generate Go source code under `_scripts/dist/` based on `ruby.h`
-
-In many cases there is an error on the last `go fmt`, but it's not a problem :sweat_smile:
+See [_tools/ruby_h2go/](_tools/ruby_h2go/)
 
 ### 2. Move function to top directory
 Modify some of the auto-generated functions and add them to the ruby package in the top directory

_scripts/dist/.keep

@@ -0,0 +1 @@
+dist/

_tools/ruby_h2go/.gitignore

@@ -0,0 +1,18 @@
+# ruby_h2go
+Convert Ruby C function definition in `ruby.h` to Go source and dump to `dist/`.
+
+## Requirements
+* Ruby
+* Go
+* ctags
+  * NOTE: `universal-ctags` is required when macOS
+  * c.f. https://formulae.brew.sh/formula/universal-ctags
+
+## Usage
+```bash
+ruby ruby_h2go.rb -H path/to/ruby/header/dir
+```
+
+* `-H` : path to ruby header dir. (default: `RbConfig::CONFIG["rubyhdrdir"]`)
+
+In many cases there is an error on the last `go fmt`, but it's not a problem :sweat_smile:

_tools/ruby_h2go/README.md

@@ -1,13 +1,7 @@
 # Convert Ruby C function definition to Go source and dump to dist/
 #
 # Usage:
-#   dump_ruby_c_functions.rb -H path/to/ruby/header/dir
-#
-# Requirements
-# * Go
-# * ctags
-#   * NOTE: `universal-ctags` is required when MacOS
-#   * c.f. https://formulae.brew.sh/formula/universal-ctags
+#   ruby_h2go.rb -H path/to/ruby/header/dir
 
 require "optparse"
 require "fileutils"