[dh-r] 30/43: Add README.md

[Gordon Ball]

This is an automated email from the git hooks/post-receive script.

chronitis-guest pushed a commit to branch master
in repository dh-r.

commit ee6eafe5af99244a3aae1746f93fb666f8b0d4a9
Author: Gordon Ball <gordon at chronitis.net>
Date:   Thu Sep 8 14:27:44 2016 +0200

    Add README.md
---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88a73d2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# dh-r
+
+## Debhelper for R packaging
+
+`dh-r` provides a debhelper buildsystem for R packages. Using it should be as simple as replacing `cdbs` with `dh-r` in `Build-Depends` and replacing `debian/rules` with:
+
+```
+#!/usr/bin/make -f
+
+%:
+    dh $@ --buildsystem R
+```
+
+### Features
+
+`dh-r` should provide parity with the existing CDBS macro (`/usr/share/R/debian/r-cran.mk`) - choosing the correct library directory, setting the build timestamp from the changelog, generating `r-base-core` and `r-api-VERSION` dependencies and cleaning up some extraneous files.
+
+In addition:
+
+ * R packages already available in the archive are automatically detected and included in the `${R:Depends}`, `${R:Recommends}` and `${R:Suggests}` substvars
+ * Script `dh-make-R` generates a `debian/` skeleton from an extracted R package tarball
+
+### Notes
+
+Build and install currently happens entirely during the debhelper `install` step (since `R CMD INSTALL` performs both as a single operation).
+
+The `fix-deps.pm` script reads an existing `debian/control` and outputs a new one to `stdout`, swapping `cdbs` for `dh-r` in `Build-Depends` and replacing binary package `Depends`, `Recommends` and `Suggests` with substvar versions. If there are depedencies apart from R and shlibs-detectable libraries they will need to be re-added.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/dh-r.git