diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 000000000..74e1d5813 --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,4 @@ +^.*\.Rproj$ +^\.Rproj\.user$ +.travis.yml +local diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..fd51293b9 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,30 @@ +# Sample .travis.yml for R projects. +# Taken from my fork of Craig Citro's r-travis +# +# See https://github.com/eddelbuettel/r-travis/ +# and https://github.com/craigcitro/r-travis +# +# See README.md for instructions. + +language: c + +env: + global: + - _R_CHECK_FORCE_SUGGESTS_=FALSE + +before_install: + - curl -OL http://raw.github.com/craigcitro/r-travis/master/scripts/travis-tool.sh + - chmod 755 ./travis-tool.sh + - ./travis-tool.sh bootstrap + +install: + ## -- nothing to do here + ## - ./travis-tool.sh install_r + +script: ./travis-tool.sh run_tests + +notifications: + email: + on_success: change + on_failure: change + diff --git a/README.md b/README.md new file mode 100644 index 000000000..c70bfb41a --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# bh: Boost Headers for R + +[![Build Status](https://travis-ci.org/eddelbuettel/bh.png)](https://travis-ci.org/eddelbuettel/bh) + +## About + +This package provides [R](http://www.r-project.org) with access to +[Boost](http://www.boost.org/) header files. [Boost](http://www.boost.org/) +provides free peer-reviewed portable C++ source libraries. A large part of +[Boost](http://www.boost.org/) is provided as C++ template code which is +resolved entirely at compile-time without linking. + +This package aims to provide the most useful subset of +[Boost](http://www.boost.org/) libraries for template use among CRAN +package. By placing these libraries in this package, we offer a more +efficient distribution system for CRAN as replication of this code in the +sources of other packages is avoided. + +It can be used via the `LinkingTo:` field in the `DESCRIPTION` field of an R +package --- and the R package infrastructure tools will then know how to set +include flags correctly on all architectures supported by R. + +Not that this can be used solely by headers-only Boost libraries. This +covers most of Boost, but excludes some libraries which require linking for +parts or all of their functionality. + +## Authors + +Dirk Eddelbuettel, Jay Emerson and Michael Kane + +## License + +This package is provided under the same license as Boost itself, the BSL-1.0