Skip to content

Commit

Permalink
Adding site-building instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
josherrickson committed Apr 2, 2024
1 parent bdbe752 commit 7a5d719
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,14 @@ the same graph of 5 nodes will be labeled 1 through 5.

For consistency in R, all function in R expect 1-indexing, and convert to
0-indexing before passing to C++.

## Rebuilding website

Run `make build_site` (or, directly, `devtools::build_site(quiet = FALSE)`) to
build the site. Assuming the package is currently on a [development
version](https://r-pkgs.org/lifecycle.html#sec-lifecycle-version-number-tidyverse),
this will build the dev site to docs/dev. To build the release site, checkout
the most recent [tagged
release](https://github.com/josherrickson/rlemon/tags), e.g. `git
checkout v0.2.1`. Build the site in that commit, which should populate docs/.
Checkout back to main, and both pkgdown sites should be build.

0 comments on commit 7a5d719

Please sign in to comment.