Skip to content
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

Jump to bottom

Make docs more accessible #247

Merged
merged 1 commit into from
Aug 3, 2023
Merged

Make docs more accessible #247

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
19 changes: 13 additions & 6 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@
The primary goal of `rb-sys` is to make building native Ruby extensions in Rust **easier** than it would be in C. If
it's not easy, it's a bug.

- [Battle-tested **Ruby FFI bindings** ](./crates/rb-sys/readme.md) for Rust (via `rb-sys` crate)
- [Ruby gem for **compiling extensions**](./gem/README.md)
- [GitHub action][setup-action] to **setup a test environment in CI**
- [GitHub action][cross-gem-action] to easily **cross compile in CI**
- [**Test helpers**)][test-helpers] for testing Ruby extensions in Rust

## Features

- Battle-tested Rust bindings for [the Ruby C API][ruby-c-api]
Expand All @@ -21,6 +15,19 @@ it's not easy, it's a bug.
- Cross compilation of gems
- Integration with [`rake-compiler`][rake-compiler]

## New to `rb-sys`?

- [Ruby on Rust Book 📖](https://oxidize-rb.github.io/rb-sys/) to describe how to build, test, and deploy a Rusty Ruby Gem
- [Contributing Docs 💻](./CONTRIBUTING.md) to get started in making your first contributions to rb-sys
- [`rb-sys` gem 💎](./gem/README.md) to learn more about the `rb-sys` gem for **compiling extensions**

## Quick links

- [Battle-tested **Ruby FFI bindings** ](./crates/rb-sys/readme.md) for Rust (via `rb-sys` crate)
- [GitHub action][setup-action] to **setup a test environment in CI**
- [GitHub action][cross-gem-action] to easily **cross compile in CI**
- [**Test helpers**)][test-helpers] for testing Ruby extensions in Rust

## Usage

Below are some examples of how to use `rb-sys` to build native Rust extensions. Use these as a starting point for your
Expand Down