Standardized README #20
Open
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
chainsawriot
previously approved these changes
Jan 31, 2025
README.md
Outdated
| - [`LICENSE.*`](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) | ||
| - [`CITATION.cff`](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) | ||
|
|
||
| Additionally, the Git repository **must** also have the [necessary files for the interactive environment](https://repo2docker.readthedocs.io/en/latest/configuration/index.html). For example, |
There was a problem hiding this comment.
necessary files for setting up a binder environment [^1].
[^1]: That environment will be used for rendering the tutorial, and optionally for interactive execution.
I think it makes the intention clear.
There was a problem hiding this comment.
I want to explicitly mention the postBuild for users not to forget.
There was a problem hiding this comment.
@rgaiacs yeah the two examples should still be there.
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.
Related to https://git.gesis.org/methods-hub/meta/-/issues/283