Skip to content

Tweak doc #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sue445 merged 1 commit into from
Nov 22, 2024
Merged

Tweak doc #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/ruby-go-gem/go-gem-wrapper)](https://goreportcard.com/report/github.com/ruby-go-gem/go-gem-wrapper)
[![Go Reference](https://pkg.go.dev/badge/github.com/ruby-go-gem/go-gem-wrapper.svg)](https://pkg.go.dev/github.com/ruby-go-gem/go-gem-wrapper)

## Overview
| Directory | Name | API Reference |
|------------------|-------------------------------------------------------|----------------------------------------------------------|
| [/](/) | `github.com/ruby-go-gem/go-gem-wrapper` (Go module) | https://pkg.go.dev/github.com/ruby-go-gem/go-gem-wrapper |
| [/_gem/](/_gem/) | [go_gem](https://rubygems.org/gems/go_gem) (Ruby gem) | https://ruby-go-gem.github.io/go-gem-wrapper/ |

## Requirements
* Go
* Ruby
Expand Down Expand Up @@ -119,21 +125,17 @@ However, some of the methods listed below are not supported.

## Developing
### Build
Run `rake ruby:build_example`. (`bundle exec` is not required)
Run `bundle exec rake ruby:example:build`.

See `rake -T` for more tasks.
See `bundle exec rake -T` for more tasks.

### See `godoc` in local
```bash
go install golang.org/x/tools/cmd/godoc@latest
godoc
```

open http://localhost:6060/pkg/github.com/ruby-go-gem/go-gem-wrapper/

## Reference
* Go: https://pkg.go.dev/github.com/ruby-go-gem/go-gem-wrapper
* Ruby: https://ruby-go-gem.github.io/go-gem-wrapper/
open http://localhost:6060/pkg/github.com/ruby-go-gem/go-gem-wrapper/ruby/

## Original idea
[Ruby meets Go - RubyKaigi 2015](https://rubykaigi.org/2015/presentations/mmasaki/)
Loading