when starting course, replace README #667
Merged
Conversation
This file contains 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
|
No broken urls! 🎉 |
cansavvy
approved these changes
Aug 10, 2023
There was a problem hiding this comment.
@KatherineCox This is excellent! Thanks for doing this! Great idea.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently the README is doing double duty - describing OTTR_Template and trying to serve as a reasonable starting point for a README for a course.
I've been working on a C-MOOR branded copy of OTTR_Template, and thought it would be useful to automatically replace the README when starting a course, so that those two concerns can be split up.
This PR
course_README_template.mdto hold the starting point for a course's READMEstarting-course.ymlto replaceREADME.mdwithcourse_README_template.mdREADME.mdintocourse_README_template.md@cansavvy If you want to make changes to this PR, go for it - I'm handing it off to you. I thought you might have other changes you would want to make to the README content, now that's being split up. I just took the existing content and distributed it between the two files (and updated the link to point to ottrproject.org).