Skip to content

Commit b112a67

Browse files
committed
new vignette entry about texlive requirements (closes #422)
1 parent 8592caa commit b112a67

File tree

3 files changed

+40
-1
lines changed

3 files changed

+40
-1
lines changed

ChangeLog

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
2016-01-29 Dirk Eddelbuettel <[email protected]>
2+
3+
* vignettes/Rcpp-FAQ.Rnw (Rcpp): Add new entry about required TeXlive
4+
installation to build vignettes (issue #422)
5+
16
2016-01-22 Dirk Eddelbuettel <[email protected]>
27

38
* DESCRIPTION (Version): Mark as 0.12.3.1

inst/NEWS.Rd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
\itemize{
2323
\item A plugin for C++14 was added (Dan in PR \ghpr{427})
2424
}
25+
\item Changes in Rcpp Documentation:
26+
\itemize{
27+
\item An entry was added to the Rcpp-FAQ vignette describing the required
28+
packages for vignette building (\ghit{422}).
29+
}
2530
}
2631
}
2732

vignettes/Rcpp-FAQ.Rnw

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1026,6 +1026,35 @@ fit into \code{integer} types, up to 53 bit precision fits into
10261026
for example from the \href{http://gmplib.org/}{GNU Multiple Precision Arithmetic
10271027
Library} may be an alternative.
10281028

1029+
\subsection{What LaTeX packages do I need to typeset the vignettes ?}
1030+
1031+
\begin{quote}
1032+
\emph{I would like to typeset the vignettes. What do I need?}
1033+
\end{quote}
1034+
1035+
The \href{https://www.tug.org/texlive/}{TeXLive} distribution seems to get
1036+
bigger and bigger. What you need to install may depend on your operating
1037+
system.
1038+
1039+
Specific per-platform notes:
1040+
\begin{description}
1041+
\item[Windows] users probably want the \href{http://miktex.org/}{MiKTeX}.
1042+
Suggestions for a more detailed walk through would be appreciated.
1043+
\item[OS X] users seem to fall into camps which like or do not like brew /
1044+
homebrew. One suggestion was to install
1045+
\href{https://tug.org/mactex/mactex-download.html}{MacTeX} but at
1046+
approximately 2.5gb (as of January 2016) this is not lightweight.
1047+
\item[Linux] users probably want the full
1048+
\href{https://www.tug.org/texlive/}{TeXLive} set from their distribution. On
1049+
\href{http://www.debian.org}{Debian} these packages are installed to build
1050+
the R package itself: \texttt{texlive-base, texlive-latex-base,
1051+
texlive-generic-recommended, texlive-fonts-recommended,
1052+
texlive-fonts-extra, texlive-extra-utils, texlive-latex-recommended,
1053+
texlive-latex-extra}. Using \texttt{texlive-full} may be a shortcut.
1054+
Fedora and other distributions should have similar packages.
1055+
\end{description}
1056+
1057+
10291058
\section{Support}
10301059

10311060
\subsection{Is the API documented ?}
@@ -1111,7 +1140,7 @@ which contained Rcpp and a number of related packages. It still has the full
11111140
history as well as number of support files.
11121141

11131142
We have since switched to a \href{http://github.com/RcppCore/Rcpp}{Git
1114-
repository at Github} for Rcpp (as well as RcppArmadillo and RcppEigen).
1143+
repository at Github} for Rcpp (as well as for RcppArmadillo and RcppEigen).
11151144

11161145
\bibliographystyle{plainnat}
11171146
\bibliography{Rcpp}

0 commit comments

Comments
 (0)