carpentries / sandpaper-docs

Documentation for The Carpentries Workbench
https://carpentries.github.io/sandpaper-docs/
Other
5 stars 45 forks source link

Update setup.md #205

Closed ErinBecker closed 1 month ago

ErinBecker commented 1 month ago

Update instructions for Windows and MacOS install based on walkthrough with @froggleston.

github-actions[bot] commented 1 month ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries/sandpaper-docs/compare/md-outputs..md-outputs-PR-205

The following changes were observed in the rendered markdown documents:

 config.yaml (gone) |  92 ------------
 episodes.md        |  16 +--
 example.md         |   6 +-
 md5sum.txt         |  44 +++---
 renv.lock (gone)   | 408 -----------------------------------------------------
 setup.md           |  82 +++++------
 6 files changed, 72 insertions(+), 576 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-10-18 16:39:16 +0000

ErinBecker commented 1 month ago

Merged based on 👍 from @froggleston