Skip to content
This repository has been archived by the owner on Jun 30, 2024. It is now read-only.

Commit

Permalink
Merge pull request #17 from extendr/intro
Browse files Browse the repository at this point in the history
  • Loading branch information
JosiahParry authored Apr 3, 2024
2 parents 484b3d0 + e6e5193 commit 7fadbe8
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 5 deletions.
4 changes: 0 additions & 4 deletions getting-started.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: Getting started

To start building R packages using extendr you will need to have R and Rust toolchain installed on your machine.

::: callout-tip
Join the [Discord server](https://discord.gg/KM3Bhwt3uk) server to chat with other extendr users and the maintainers.
:::

## R

Ensure that you have a relatively new version of R installed. It is recommended to use a moderately new version (>= 4.2.0).
Expand Down
23 changes: 22 additions & 1 deletion index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,25 @@ title: "extendR: User guide"

# Introduction

extendR is a suite of software packages concerned with bridging R and Rust, through automatically generated bindings. See <https://extendr.github.io/> for more information. This website is a _user_ guide to all things extendr, Rust, R and the confluence of all three.
The extendr suite of software packages provides a set of utilities for bridging
the R and Rust programming languages, making it easier for users to pass data
between them using automatically generated bindings. In so doing, it overcomes a
fundamental challenge of all such language bindings, namely, the fact that the
two languages make different design choices regarding the representation of data
types. Most of the time, data types in Rust and R map quite nicely. In other
cases, it takes careful consideration. And, in a few unfortunate cases, it is
not even possible. Generally speaking, though, if an R version of a Rust type
exists, extendr will do that mapping for you, but you will on occasion have to
do some of that work yourself.

To help guide you toward best practices here, we have put together this website
as a *user* guide, with lots of examples showcasing all things extendr, Rust,
and R, as well as the confluence of all three.

See <https://extendr.github.io/> for more information.

## Community Support

If you have any questions or are looking for advice, feel free to join the
community's [Discord server](https://discord.gg/KM3Bhwt3uk). You can usually
find the maintainers there, as well as other helpful extendr users.

0 comments on commit 7fadbe8

Please sign in to comment.