diff --git a/README.md b/README.md index 9fb020f..f4dc249 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,44 @@ rzmq is a message queue for serialized R objects. * ZMQ devices are not implemented yet, nor is zmq_poll. * Look for more features shortly. +### Installation + +Binary packages for __OS-X__ or __Windows__ can be installed directly from CRAN: + +```r +install.packages("rzmq") +``` + +#### Build from source + +Installation from source requires [`ZeroMQ`](http://zeromq.org/area:download). On __Debian__ or __Ubuntu__ use [libzmq3-dev](https://packages.debian.org/testing/libzmq3-dev): + +``` +sudo apt-get install -y libzmq3-dev +``` + +On __Fedora__ we need [zeromq3-devel](https://apps.fedoraproject.org/packages/zeromq3-devel): + +``` +sudo yum install zeromq3-devel +```` + +On __CentOS / RHEL__ we install [zeromq3-devel](https://apps.fedoraproject.org/packages/zeromq3-devel) via EPEL: + +``` +sudo yum install epel-release +sudo yum install zeromq3-devel +``` + +On __OS-X__ use [zeromq](https://github.com/Homebrew/homebrew-core/blob/master/Formula/zeromq.rb) from Homebrew: + +``` +brew install zeromq +``` + + ### Usage + A minimal example of remote execution. execute this R script on the remote server: diff --git a/configure b/configure index 58484ac..7338fa2 100755 --- a/configure +++ b/configure @@ -54,17 +54,18 @@ CXXCPP=$(${R_HOME}/bin/R CMD config CXXCPP) CXXFLAGS=$(${R_HOME}/bin/R CMD config CXXFLAGS) CPPFLAGS=$(${R_HOME}/bin/R CMD config CPPFLAGS) -# Test for libv8 +# Test for libzmq echo "#include $PKG_TEST_HEADER" | ${CXXCPP} ${CPPFLAGS} ${PKG_CFLAGS} ${CXXFLAGS} -xc++ - >/dev/null 2>&1 if [ $? -ne 0 ]; then echo "------------------------- ANTICONF ERROR ---------------------------" echo "Configuration failed because $PKG_CONFIG_NAME was not found. Try installing:" - echo " * deb: $PKG_DEB_NAME (Debian, Ubuntu)" - echo " * rpm: $PKG_RPM_NAME (Fedora, EPEL)" - echo " * brew: $PKG_BREW_NAME (OSX) -- NOT regular v8! Tap from homebrew/versions" + echo " * deb: $PKG_DEB_NAME (Debian, Ubuntu, etc)" + echo " * rpm: $PKG_RPM_NAME (Fedora, CentOS, RHEL)" echo " * csw: $PKG_CSW_NAME (Solaris)" - echo "To use a custom libv8, set INCLUDE_DIR and LIB_DIR manually via:" + echo "If $PKG_CONFIG_NAME is already installed, check that 'pkg-config' is in your" + echo "PATH and PKG_CONFIG_PATH contains a $PKG_CONFIG_NAME.pc file. If pkg-config" + echo "is unavailable you can set INCLUDE_DIR and LIB_DIR manually via:" echo "R CMD INSTALL --configure-vars='INCLUDE_DIR=... LIB_DIR=...'" echo "--------------------------------------------------------------------" exit 1;