docs: Add install instructions in README

Author: danieledler

.Rbuildignore

@@ -0,0 +1,2 @@
+^.*\.Rproj$
+^\.Rproj\.user$

.gitignore

@@ -1,3 +1,7 @@
 *.o
 *.so
 .Rhistory
+*.Rcheck
+.Rproj.user
+*.tgz
+*.tar.gz

DESCRIPTION

@@ -1,14 +1,18 @@
 Package: swigr
-Title: What the Package Does (One Line, Title Case)
+Title: An example R package using SWIG to wrap C++
 Version: 0.0.1
 Authors@R: 
     person(given = "First",
            family = "Last",
            role = c("aut", "cre"),
            email = "[email protected]",
            comment = c(ORCID = "YOUR-ORCID-ID"))
-Description: What the package does (one paragraph).
-License: What license it uses
+Description: A simple example repo to test making an R package
+  from C++ code using SWIG to generate wrapper code. The goal is
+  to make it easy to install for both Linux, MacOS and Windows
+  users. Windows users should be able to install a binary package
+  to not require tools to compile the C++ code.
+License: AGPL (>= 3)
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.1.0

README.md

@@ -1,6 +1,26 @@
-# swigr
-An example project to test building an R package from C++ code using SWIG
+# SwigR - An example R package using SWIG to wrap C++
+
+A simple example repo to test making an R package
+from C++ code using SWIG to generate wrapper code. The goal is
+to make it easy to install for both Linux, MacOS and Windows
+users. Windows users should be able to install a binary package
+to not require tools to compile the C++ code.
+
+## Install
+
+Swigr can be installed as a source package from R by running
+
+```R
+devtools::install_github("danieledler/swigr")
+```
+
+Binary bundle can be installed from R by running
+
+```R
+devtools::install_url("https://github.com/danieledler/swigr/releases/download/v0.0.1/swigr_0.0.1.tgz")
+```
+
 
 ## TODO
 
-Add `zzz.R` with `.onUnload()` to clean SWIG?
+* Add `zzz.R` with `.onUnload()` to clean SWIG?

build.R

@@ -20,6 +20,9 @@ setwd("~/dev/R/swig")
 devtools::install("swigr")
 setwd("~/dev/R/swig/swigr")
 
+# Install local binary bundle
+devtools::install_url("file:///Users/Daniel/dev/R/swig/swigr_bin_man.tgz")
+
 # Test package
 swigr::test_r()
 swigr::test_example()

demo/runme.R

@@ -5,9 +5,21 @@
 # source("example.R")
 # cacheMetaData(1)
 
+search()
+#detach(package:swig, unload = TRUE)
+
 install.packages("devtools")
+
+# Install from github
 devtools::install_github("danieledler/swigr")
 
+# Install source bundle from URL
+devtools::install_url("https://github.com/danieledler/swigr/releases/download/v0.0.1/swigr_0.0.1.tar.gz")
+
+# Install binary bundle from URL
+devtools::install_url("https://github.com/danieledler/swigr/releases/download/v0.0.1/swigr_0.0.1.tgz")
+
+
 swigr::test_example()
 
 # ----- Object creation -----

swigr.Rproj

@@ -0,0 +1,17 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source