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

Update README.md #117

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #117

wants to merge 1 commit into from

Conversation

martinamorris
Copy link
Member

Added a more user friendly description of package utility, and links to the tergm workshop, 4.0 crosswalk vignette and citation. This updates the README to the new format.

Added a more user friendly description of package utility, and links to the tergm workshop, 4.0 crosswalk vignette and citation.  This updates the README to the new format.
@krivit
Copy link
Member

krivit commented Nov 30, 2023

OK, we need to figure out what to do with this. Basically, right now all README files for packages I maintain are generated with the script https://github.com/statnet/utilities/blob/master/mk_README , which uses a template into which package name and other information are inserted.

If we want other text in there, we need to have the script be able to either recognise that the README has been edited manually and merge the changes or be able to incorporate additional information, say from another file.

@mbojan
Copy link
Member

mbojan commented Nov 30, 2023

Oh... I did not know that READMEs are generated. That will also overwrite the CoC-related paragraph I added lately... Is this a bridge too far in terms of automation? Incidentally, I have no access to statnet/utilities (I'm getting 404).

@krivit
Copy link
Member

krivit commented Dec 1, 2023

Oh... I did not know that READMEs are generated. That will also overwrite the CoC-related paragraph I added lately... Is this a bridge too far in terms of automation? Incidentally, I have no access to statnet/utilities (I'm getting 404).

Oops. Added. Yes, that would be clobbered as well. If we are implementing a CoC everywhere, we can add it to the template, so that's straightforward.

It shouldn't be hard to have an "API" for inserting bits of text or perhaps some kind of fences that could be used to extract text to be preserved when overwriting, either.

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.

3 participants