Update Readme
mirenradia opened this issue · 1 comments
mirenradia commented
The main README needs to be extended and updated in order to meet the requirements for JOSS (see this). In particular we need to provide a "high-level overview" of what's in the wiki including some brief notes of
- available features/capabilities
- installation instructions/prerequisites
We should also link to the relevant wiki pages as appropriate.
Finally, it'd be great to include our logo and some badges (e.g. like the TwoPunctures readme)
KAClough commented
I've mainly just updated the wording in the PR and linked to the wiki - I prefer to do this rather than duplicate the wording there. We can add images in the future, this would be great! But I think it is not urgent for now.