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.

Sign up for GitHub

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

Jump to bottom

Improve project readme #31

Closed
raehik opened this issue Mar 27, 2023 · 3 comments · Fixed by #38
Closed

Improve project readme #31

raehik opened this issue Mar 27, 2023 · 3 comments · Fixed by #38
Milestone
First release del...

Comments

@raehik
Copy link
Contributor

raehik commented Mar 27, 2023

Many points in #18 could be added in the readme.
@raehik raehik added this to the Initial Hugging Face upload milestone Mar 28, 2023
@raehik
Copy link
Contributor Author

raehik commented Mar 28, 2023

This should be part of the initial Hugging Face upload for discoverability.

@dorchard
Copy link
Collaborator

Todo:

  • Statement of need
    • Overview of software and purpose
  • References to papers
  • Mention that repository is supported by M2LInES (and any other relevant supporting/funding orgs)

@dorchard
Copy link
Collaborator

This should be part of the initial Hugging Face upload for discoverability.

I think this is part of an earlier milestone now.

@dorchard dorchard mentioned this issue May 12, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
First release deliverable: reusable c...
Development

Successfully merging a pull request may close this issue.

README.md details m2lines/gz21_ocean_momentum
2 participants
@dorchard @raehik