docs: expand installation section, add license explanation, link NEWS.md#16
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Partially addresses #1 and #9.
Expands the README in three ways to address feedback from both Allen and Sadie during package review:
Changes
Installation section
devtools::load_all()anddevtools::install()from a local clone[!NOTE]block clarifying that cloning the repository alone does not makelibrary(rfaR)work — the package must be installed or loaded viadevtools::load_all()License section (new)
LICENSEandLICENSE.notefiles. Both are CRAN-compliant;LICENSEis the R stub naming copyright holder and year,LICENSE.notecontains the full BSD 3-Clause text plus the USACE government disclaimer.What's New section (new)
NEWS.mdfor version history.Testing
R CMD checkpasses clean (README changes only)<details>/</details>structure renders correctly with the License section visible (not hidden inside the Plotting Results collapsible)