[Rcpp-commits] r1833 - pkg/Rcpp/inst

[noreply at r-forge.r-project.org]

Author: edd
Date: 2010-07-08 12:09:53 +0200 (Thu, 08 Jul 2010)
New Revision: 1833

Modified:
   pkg/Rcpp/inst/README
Log:
updated and extended


Modified: pkg/Rcpp/inst/README
===================================================================
--- pkg/Rcpp/inst/README	2010-07-08 09:34:28 UTC (rev 1832)
+++ pkg/Rcpp/inst/README	2010-07-08 10:09:53 UTC (rev 1833)
@@ -1,20 +1,52 @@
 
+History
+=======
+
 Rcpp continues and extends earlier work by Dominik Samperi which he initially
 contributed directly into the RQuantLib package. Then, during 2005 and 2006,
 several releases were made as CRAN packages, first under the name Rcpp and
 later under the name RcppTemplate.  However, both packages were left
-abandonded after November 2006.
+abandonded after November 2006.  Later, in November 2009, two brief releases
+were made and abandonded immediately afterwards.
 
-Due to my continued use of Rcpp both within RQuantLib and in other projects,
-I took over maintenance and added some extensions which are documented in the
-ChangeLog as well as in even more detail in the Subversion logs on R-Forge.
+Due to the continued use of Rcpp both within RQuantLib and in other projects,
+Dirk took over maintenance in November 2008 and added some extensions which
+are documented in the NEWS file, the ChangeLog and the included annoucements
+of the major releases.
 
-As of November 2009, Dominick has re-commenced maintenance of RcppTemplate
-with new releases on CRAN.  This may provide a good opportunity to import
-some new ideas into Rcpp as well, time permitting.
+With Romain joining development in late 2009, Rcpp development accelerated. A
+richer, more powerful API has been added (while maintaining full
+compatibility with the initial API, which we now call 'classic Rcpp API').
 
+
+Documentation
+=============
+
+Several so-called 'vignette' pdf documents are included which provide
+
+     o	an introduction;
+
+     o	answers to frequently asked question;
+
+     o	documentation about how to use Rcpp in other R packages;
+
+     o	documentation of modules (to access C++ classes and functions);
+
+     o  documentation of sugar (expressive C++ code for vectors and matrices);
+
+     o	notes about extending Rcpp;
+
+     o  results from the hundreds of unit tests.
+
+The CRAN package RcppExamples provides additionnal documentation and
+examples.
+
+
+Contact
+=======
+
 Rcpp is in active and open development, and new contributors are invited to
-join the R-Forge project.
+join the R-Forge project. The rcpp-devel project mailing list is the main
+venue for discussions about Rcpp.
 
-  -- Dirk Eddelbuettel <edd at debian.org>  Fri, 06 Nov 2009 12:29:52 -0600
-
+   -- Dirk Eddelbuettel and Romain Francois