From 0dd185657939eabb976811c1f768f17b3247afab Mon Sep 17 00:00:00 2001 From: Youssef Makboul Date: Wed, 2 Aug 2023 20:45:11 -0400 Subject: [PATCH] Make docs more accessible (#247) --- readme.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 69e8658d..cdb38d38 100644 --- a/readme.md +++ b/readme.md @@ -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] @@ -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