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

Flesh out README with useful information and showcase of plots #27

Closed
sadielbartholomew opened this issue Feb 29, 2024 · 0 comments · Fixed by #30
Closed

Flesh out README with useful information and showcase of plots #27

sadielbartholomew opened this issue Feb 29, 2024 · 0 comments · Fixed by #30
Assignees
Labels

Comments

@sadielbartholomew
Copy link
Member

The README is very bare at the moment. We should populate it with plenty of information, for example quoting from the GitHub documentation page on READMEs:

A README is often the first item a visitor will see when visiting your repository. README files typically include information on:

What the project does
Why the project is useful
How users can get started with the project
Where users can get help with your project
Who maintains and contributes to the project

In particular I would like to include some images and links, notably showcasing some nice plots that cf-plot can make, and linking and advertising cf-python as the underlying data analysis tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant