Skip to content

Commit de5bc00

Browse files
committed
some additions to main README
1 parent bb15a12 commit de5bc00

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ package development. Attributes are built on top of Rcpp modules and
4242
their implementation is based on previous work in the inline package.
4343
See the [Rcpp-atttributes]((http://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-attributes.pdf) vignettes for more details.
4444

45+
## Examples
46+
4547
Many examples are included, and over 800 unit tests in over 400 unit
4648
test functions provide additional usage examples.
4749

@@ -51,8 +53,13 @@ been factored out of Rcpp into the package RcppClassic, and it is still
5153
available for code relying on the older interface. New development should
5254
always use this Rcpp package instead.
5355

56+
## Documentation
57+
58+
The package ships with nine pdf vignettes.
59+
5460
Additional documentation is available via the [JSS paper](http://www.jstatsoft.org/v40/i08/) by Eddelbuettel and
55-
Francois (2011, JSS) paper and the [book](http://www.rcpp.org/book) by Eddelbuettel (2013, Springer);
61+
Francois (2011, JSS) paper (corresponding to the 'intro' vignette)
62+
and the [book](http://www.rcpp.org/book) by Eddelbuettel (2013, Springer);
5663
see 'citation("Rcpp")' for details.
5764

5865
## Installation
@@ -64,14 +71,15 @@ Released and tested versions of Rcpp are available via the
6471
install.packages("Rcpp")
6572
```
6673

67-
To install Rcpp snapshots directly from the master branch at GitHub, do
68-
69-
```R
70-
install.packages("devtools")
71-
devtools::install_github("RcppCore/Rcpp")
72-
```
73-
7474
To install from source, ensure you have a
7575
[complete package development environment](http://www.rstudio.com/ide/docs/packages/prerequisites).
76-
7776
Also see questions 1.2 and 1.3 in the [Rcpp-FAQ](http://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-FAQ.pdf).
77+
78+
### Authors
79+
80+
Dirk Eddelbuettel, Romain Francois, JJ Allaire, Doug Bates, John Chamber and
81+
Kevin Ushey
82+
83+
### License
84+
85+
GPL (>= 2)

0 commit comments

Comments
 (0)