updated quickstart

mkoohafkan · Jul 31, 2019 · af95ab6 · af95ab6
1 parent f32db1d
commit af95ab6
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/vignettes/_quickstart.rmd b/vignettes/_quickstart.rmd
@@ -12,7 +12,7 @@ vignette: >
 This document gets you up and running with `hdfqlr`, an R interface to
 [HDFql](http://www.hdfql.com/). In order to use this package, you will 
 need to [download HDFql](http://www.hdfql.com/#download) for your 
-system.
+system. 
 
 If you are going to be using HDFql regularly, it's a good idea to set
 a default HDFql directory for use with `hdfqlr`. You can do this 
@@ -33,6 +33,14 @@ Otherwise, you can load the HDFql library after package start with
 hql_load('path/to/hdfql-x.x.x')
 ```
 
+If you are on a Linux system, you will need to update
+the environment variable `LD_LIBRARY_PATH` to include the HDFql 
+directories prior to using the package:
+
+```{bash, eval = FALSE}
+export LD_LIBRARY_PATH=<hdfql_r_wrapper_directory>:<hdfql_lib_directory>:$LD_LIBRARY_PATH
+```
+
 The `hdfqlr` package relies on the R wrapper provided by HDFql. 
 Functions exported by the package are prefixed with `hql_` to 
 make it easy to differentiate them from the functions provided 

diff --git a/vignettes/quickstart.rmd b/vignettes/quickstart.rmd
@@ -1,7 +1,7 @@
 ---
 title: "Quick Start"
 author: "Michael Koohafkan"
-date: 2019-07-18
+date: 2019-07-31
 output: rmarkdown::html_vignette
 vignette: >
   %\VignetteIndexEntry{Quick Start}
@@ -12,7 +12,7 @@ vignette: >
 This document gets you up and running with `hdfqlr`, an R interface to
 [HDFql](http://www.hdfql.com/). In order to use this package, you will 
 need to [download HDFql](http://www.hdfql.com/#download) for your 
-system.
+system. 
 
 If you are going to be using HDFql regularly, it's a good idea to set
 a default HDFql directory for use with `hdfqlr`. You can do this 
@@ -35,6 +35,15 @@ Otherwise, you can load the HDFql library after package start with
 hql_load('path/to/hdfql-x.x.x')
 ```
 
+If you are on a Linux system, you will need to update
+the environment variable `LD_LIBRARY_PATH` to include the HDFql 
+directories prior to using the package:
+
+
+```bash
+export LD_LIBRARY_PATH=<hdfql_r_wrapper_directory>:<hdfql_lib_directory>:$LD_LIBRARY_PATH
+```
+
 The `hdfqlr` package relies on the R wrapper provided by HDFql. 
 Functions exported by the package are prefixed with `hql_` to 
 make it easy to differentiate them from the functions provided