search

carpentries-incubator / fair-research-software

A course on tools and practices for open, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software
https://carpentries-incubator.github.io/fair-research-software/
Other
8 stars 4 forks source link

Setup instructions #32

Closed anenadic closed 3 months ago

anenadic commented 4 months ago

Started work on the setup section - still work in prorgess.

github-actions[bot] commented 4 months 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-incubator/fair-research-software/compare/md-outputs..md-outputs-PR-32

The following changes were observed in the rendered markdown documents:

 00-introduction.md                    |  12 +-
 01-fair-research-software.md          |  31 +--
 fig/GitBash-default-editor.png (new)  | Bin 0 -> 637998 bytes
 fig/vscode-git-extensions.png (new)   | Bin 0 -> 808326 bytes
 fig/vscode-python-extension.png (new) | Bin 0 -> 875687 bytes
 fig/vscode-terminal.png (new)         | Bin 0 -> 527669 bytes
 index.md                              |  16 +-
 md5sum.txt                            |   8 +-
 setup.md                              | 342 +++++++++++++++++++++++++++++++---
 9 files changed, 345 insertions(+), 64 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-03-10 15:19:36 +0000

anenadic commented 4 months ago

More instructions have been added and some screenshots - there are still a few screenshots that I'd like to add and the one for Windows needs redoing, and the last section on VS Code integration with various tools needs a bit more text but we should probably test these instructions sooner rather than later and add the final small details later.