Skip to content

Improve readme#60

Merged
jwaiton merged 4 commits intonu-ZOO:mainfrom
jwaiton:improve-README
Feb 18, 2026
Merged

Improve readme#60
jwaiton merged 4 commits intonu-ZOO:mainfrom
jwaiton:improve-README

Conversation

@jwaiton
Copy link
Member

@jwaiton jwaiton commented Feb 2, 2026

This PR includes a more updated README with:

  • installation instructions,
  • quickstart guide,
  • contribution guidelines,
  • citations and a cff file,
  • explicit licensing
  • and fun badges!

@jwaiton jwaiton requested a review from a team February 2, 2026 17:35
@jwaiton jwaiton requested a review from Tedsmith100 February 18, 2026 10:09
},
}
```
The full citation is provided in [CITATION.cff](https://github.com/nu-ZOO/MULE/blob/main/CITATION.cff), and all styles are autogenerated at zenodo DOI link above (or [here](https://doi.org/10.5281/zenodo.18418497)).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CITATION.cff link doesn't work

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When this PR is submitted, the CITATION.cff link will be activated :)

Copy link

@Tedsmith100 Tedsmith100 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good work

@jwaiton jwaiton merged commit 5f4d604 into nu-ZOO:main Feb 18, 2026
1 check passed
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.

2 participants