Skip to content

Add links (as examples) to a few repos with good READMEs #47

@egrace479

Description

@egrace479

It'd probably be helpful to link to a few different types of repos that have good READMEs as examples under the README section of the GitHub Repo Guide. I was thinking:

  • BioCLIP 2 provides a good example for a large project
    • it has data, model, the code, and a demo
    • it builds on previous work: models how to cite, also the license is a bit more complex but handled well
    • it also is re-used a lot within Imageomics as a base style
  • For a code/software-based project we could use cautious-robot, sum-buddy, or emb-explorer
    • SST also has some nice elements as paper + tool, though I generally wouldn't want to recommend including the citation in the README.
    • Andromeda points to some docs in the wiki too, perhaps a simpler example for when to add some extra pages elsewhere.

We should also make sure the GitHub Repo Guide page links out to the code checklist.

@hlapp, what do you think?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestquestionFurther information is requested

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions