+ installation instructions

apache · Aug 28, 2018 · ca9d7f0 · ca9d7f0
1 parent 28d8d80
commit ca9d7f0
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 0 deletions.
diff --git 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
@@ -1,2 +1,3 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^README\.Rmd$
diff --git a/r/README.Rmd 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
@@ -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)