Skip to content

Commit 3368d63

Browse files
committed
update docs/
1 parent d347b43 commit 3368d63

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+752
-935
lines changed

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
<div class="submenu">
4444
<label>Vignettes</label>
45-
<a href="vignettes/01-motivations.html">01 - Motivations for cpp4r</a>
45+
<a href="vignettes/01-intro.html">01 - Introduction</a>
4646
<a href="vignettes/02-setup.html">02 - Setup</a>
4747
<a href="vignettes/03-package-skeleton.html">03 - Package Skeleton</a>
4848
<a href="vignettes/04-read-only.html">04 - Read-only versus Writable R Objects</a>

docs/last-updated.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"last_updated": "Last updated: 2025-11-07 12:56:52"
2+
"last_updated": "Last updated: 2025-11-29 20:43:17"
33
}

docs/news/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
<div class="submenu">
4444
<label>Vignettes</label>
45-
<a href="../vignettes/01-motivations.html">01 - Motivations for cpp4r</a>
45+
<a href="../vignettes/01-intro.html">01 - Introduction</a>
4646
<a href="../vignettes/02-setup.html">02 - Setup</a>
4747
<a href="../vignettes/03-package-skeleton.html">03 - Package Skeleton</a>
4848
<a href="../vignettes/04-read-only.html">04 - Read-only versus Writable R Objects</a>

docs/reference/pkg_template.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
<div class="submenu">
4444
<label>Vignettes</label>
45-
<a href="../vignettes/01-motivations.html">01 - Motivations for cpp4r</a>
45+
<a href="../vignettes/01-intro.html">01 - Introduction</a>
4646
<a href="../vignettes/02-setup.html">02 - Setup</a>
4747
<a href="../vignettes/03-package-skeleton.html">03 - Package Skeleton</a>
4848
<a href="../vignettes/04-read-only.html">04 - Read-only versus Writable R Objects</a>

docs/reference/register.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
<div class="submenu">
4444
<label>Vignettes</label>
45-
<a href="../vignettes/01-motivations.html">01 - Motivations for cpp4r</a>
45+
<a href="../vignettes/01-intro.html">01 - Introduction</a>
4646
<a href="../vignettes/02-setup.html">02 - Setup</a>
4747
<a href="../vignettes/03-package-skeleton.html">03 - Package Skeleton</a>
4848
<a href="../vignettes/04-read-only.html">04 - Read-only versus Writable R Objects</a>
@@ -81,9 +81,6 @@ <h3>Description</h3>
8181
<p>Note registered functions will not be <em>exported</em> from your package unless
8282
you also add a <code style="white-space: pre;">⁠@export⁠</code> roxygen2 directive for them.
8383
</p>
84-
<p>In order to use <code>register()</code> the <code>cli</code>, <code>decor</code>, <code>desc</code>, <code>glue</code>,
85-
<code>tibble</code> and <code>vctrs</code> packages must also be installed.
86-
</p>
8784

8885

8986
<h3>Usage</h3>

docs/reference/unvendor.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
<div class="submenu">
4444
<label>Vignettes</label>
45-
<a href="../vignettes/01-motivations.html">01 - Motivations for cpp4r</a>
45+
<a href="../vignettes/01-intro.html">01 - Introduction</a>
4646
<a href="../vignettes/02-setup.html">02 - Setup</a>
4747
<a href="../vignettes/03-package-skeleton.html">03 - Package Skeleton</a>
4848
<a href="../vignettes/04-read-only.html">04 - Read-only versus Writable R Objects</a>

docs/reference/vendor.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
<div class="submenu">
4444
<label>Vignettes</label>
45-
<a href="../vignettes/01-motivations.html">01 - Motivations for cpp4r</a>
45+
<a href="../vignettes/01-intro.html">01 - Introduction</a>
4646
<a href="../vignettes/02-setup.html">02 - Setup</a>
4747
<a href="../vignettes/03-package-skeleton.html">03 - Package Skeleton</a>
4848
<a href="../vignettes/04-read-only.html">04 - Read-only versus Writable R Objects</a>

docs/search.json

Lines changed: 11 additions & 11 deletions
Large diffs are not rendered by default.
Lines changed: 95 additions & 120 deletions
Large diffs are not rendered by default.

docs/vignettes/02-setup.html

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
<div class="submenu">
4444
<label>Vignettes</label>
45-
<a href="../vignettes/01-motivations.html">01 - Motivations for cpp4r</a>
45+
<a href="../vignettes/01-intro.html">01 - Introduction</a>
4646
<a href="../vignettes/02-setup.html">02 - Setup</a>
4747
<a href="../vignettes/03-package-skeleton.html">03 - Package Skeleton</a>
4848
<a href="../vignettes/04-read-only.html">04 - Read-only versus Writable R Objects</a>
@@ -69,22 +69,27 @@
6969
<div id="content">
7070
<div class="content-wrapper">
7171
<div class="content-main">
72-
<h1>02 - Setup</h1>
72+
<h1></h1>
7373
<script src="libs/header-attrs-2.30/header-attrs.js"></script><h1 class="title toc-ignore">02 - Setup</h1>
7474

7575

7676

77-
<div id="c-setup" class="section level1">
78-
<h1>C++ Setup</h1>
79-
<p>You will need a working C++ compiler capable of compiling C++11 code.
80-
To get it:</p>
77+
<div id="c-setup" class="section level2">
78+
<h2>C++ Setup</h2>
79+
<p>You will need a working C++ compiler capable of compiling C++ code
80+
using the C++11 standard or newer. To get it:</p>
8181
<ul><li>On Windows, install <a href="https://cran.r-project.org/bin/windows/Rtools/">Rtools</a>.</li>
8282
<li>On Mac, install Xcode from the App Store.</li>
8383
<li>On Linux,
8484
<code>sudo pacman -Syu install build-essential g++-11</code> or
8585
similar.</li>
86-
</ul><div id="for-ubuntu-users" class="section level2">
87-
<h2>For Ubuntu Users</h2>
86+
</ul><p>On my laptop, this is the output of <code>g++ --version</code>:</p>
87+
<pre class="bash"><code>g++ (GCC) 15.2.1 20250813
88+
Copyright (C) 2025 Free Software Foundation, Inc.
89+
This is free software; see the source for copying conditions. There is NO
90+
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</code></pre>
91+
<div id="for-ubuntu-users" class="section level3">
92+
<h3>For Ubuntu Users</h3>
8893
<p>After installing <code>g++-11</code>, you may still encounter issues
8994
compiling C++ code due to missing standard library headers. This does
9095
not happen when testing on Manjaro Linux.</p>
@@ -111,8 +116,8 @@ <h2>For Ubuntu Users</h2>
111116
cannot find -lc++abi: No such file or directory</code></pre>
112117
</div>
113118
</div>
114-
<div id="r-setup" class="section level1">
115-
<h1>R Setup</h1>
119+
<div id="r-setup" class="section level2">
120+
<h2>R Setup</h2>
116121
<p>You can install the R packages <code>bench</code>,
117122
<code>cpp4r</code>, <code>devtools</code> and <code>usethis</code> with
118123
the following command:</p>

0 commit comments

Comments
 (0)