Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add readme section #10

Merged
merged 8 commits into from
Jun 22, 2024
Merged

Add readme section #10

merged 8 commits into from
Jun 22, 2024

Conversation

MarionBWeinzierl
Copy link

@MarionBWeinzierl MarionBWeinzierl commented Jun 20, 2024

Added section about ReadMes and other standard files in the repository, as well as licenses.

Closes #3 .

Copy link
Member

@jatkinson1000 jatkinson1000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MarionBWeinzierl

This seems sensible to me.
A couple of additional comments for your consideration.

On images - If I think the url will be long-lived I tend to refer to it by link in the sides rather than uploading the image to the repo. The disadvantage here is that it may disappear at some point (has happened to me) or won't load without internet. So a matter of preference. I'm still not convinced that this is the 'correct' approach 🤷‍♀️

slides/_licenses.qmd Outdated Show resolved Hide resolved
slides/_licenses.qmd Show resolved Hide resolved
slides/_comments_docstrings.qmd Show resolved Hide resolved
slides/_comments_docstrings.qmd Show resolved Hide resolved
Copy link
Member

@jatkinson1000 jatkinson1000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, this looks great to me!
Happy for you to merge at will.

slides/_licenses.qmd Show resolved Hide resolved
@MarionBWeinzierl MarionBWeinzierl merged commit 4a9f87c into main Jun 22, 2024
1 check passed
@jatkinson1000 jatkinson1000 deleted the add_readme_section branch July 17, 2024 20:41
jatkinson1000 added a commit that referenced this pull request Jul 23, 2024
* Update frontmatter to include all presenters.

* Update endmatter to be relevant to session and include details for presenters and code clinics.

* Update broken image in _rse.qmd.

* Remove incorrect ORCiD

* Add Mastodon for @ MarionBWeinzierl

Co-authored-by: Marion <56403724+MarionBWeinzierl@users.noreply.github.com>

* Add intro slide on 'where your code may go'.

* fixed typos

---------

Co-authored-by: Marion <56403724+MarionBWeinzierl@users.noreply.github.com>
Co-authored-by: MarionBWeinzierl <mw925@cam.ac.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add section on README
2 participants