From ca9d7f0b99be35f84212bd1a0a3ea3c17f4d8826 Mon Sep 17 00:00:00 2001
From: Romain Francois <romain@purrple.cat>
Date: Tue, 28 Aug 2018 14:45:01 +0200
Subject: [PATCH] + installation instructions

---
 dev/release/rat_exclude_files.txt |  2 ++
 r/.Rbuildignore                   |  1 +
 r/README.Rmd                      | 40 +++++++++++++++++++++++++++++++
 r/README.md                       | 29 ++++++++++++++++++++++
 4 files changed, 72 insertions(+)
 create mode 100644 r/README.Rmd
 create mode 100644 r/README.md

diff --git a/dev/release/rat_exclude_files.txt b/dev/release/rat_exclude_files.txt
index edc8689bb7a85..dd64d1c565fcf 100644
--- a/dev/release/rat_exclude_files.txt
+++ b/dev/release/rat_exclude_files.txt
@@ -122,3 +122,5 @@ r/LICENSE.md
 r/NAMESPACE
 r/.Rbuildignore
 r/arrow.Rproj
+r/README.md
+r/README.Rmd
diff --git a/r/.Rbuildignore b/r/.Rbuildignore
index 91114bf2f2bba..931662bbd0ea9 100644
--- a/r/.Rbuildignore
+++ b/r/.Rbuildignore
@@ -1,2 +1,3 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^README\.Rmd$
diff --git a/r/README.Rmd b/r/README.Rmd
new file mode 100644
index 0000000000000..2b5aaafa0fa66
--- /dev/null
+++ b/r/README.Rmd
@@ -0,0 +1,40 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r setup, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+# arrow
+
+Low level bindings to the C++ Apache Arrow library
+
+## Installation
+
+First install a release build of the C++ bindings to arrow.
+
+```shell
+git clone https://github.com/apache/arrow.git
+cd arrow/cpp && mkdir release && cd release
+
+# It is important to statically link to boost libraries
+cmake .. -DCMAKE_BUILD_TYPE=Release -DARROW_BOOST_USE_SHARED:BOOL=Off
+make install
+```
+
+Then the R package: 
+
+```r
+devtools::install_github("apache/arrow/r")
+```
+
+## Example
+
+(not yet)
diff --git a/r/README.md b/r/README.md
new file mode 100644
index 0000000000000..e166cf107f75d
--- /dev/null
+++ b/r/README.md
@@ -0,0 +1,29 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# arrow
+
+Low level bindings to the C++ Apache Arrow library
+
+## Installation
+
+First install a release build of the C++ bindings to arrow.
+
+``` shell
+git clone https://github.com/apache/arrow.git
+cd arrow/cpp && mkdir release && cd release
+
+# It is important to statically link to boost libraries
+cmake .. -DCMAKE_BUILD_TYPE=Release -DARROW_BOOST_USE_SHARED:BOOL=Off
+make install
+```
+
+Then the R package:
+
+``` r
+devtools::install_github("apache/arrow/r")
+```
+
+## Example
+
+(not yet)