Slight modification of README.md #57
Conversation
Adding some notice blocks, citation and fixing typos.
|
I've added a few notice blocks to highlight some parts. The style of notice blocks seems great to attract the reader's attention. However, I don't have any strong opinion on them. I also fixed a few typos and added a citation block. Maybe the citation block should come sooner in the README to make sure people know how to cite properly. Finally, I used double $ for equations as this seems to work on PyPI. @danielhollas, could you have a look a see what you think about these changes? |
Add JPCL citation
|
I was also exploring the option to add the paper to the CITATION.cff but I'm not convinced this is the best option. |
danielhollas
left a comment
danielhollas
left a comment
There was a problem hiding this comment.
Looks great! I am a big fan of these, I agree the "alerts" or admonitions make for a nice visual emphasis and we should use them more.
The original way was the best; I couldn't find a good way how to display inline maths on PyPI. Single $ doesn't work and $$ puts everything on a new line. Suggestions I found propose to use Unicode characters but this won't make it the same as equations. Anyways, it's important if it displays correctly on GitHub, not PyPI. (Side note, maybe the documentation could move to Github Wiki?)
Co-authored-by: Daniel Hollas <daniel.hollas@bristol.ac.uk>
Adding some notice blocks, citation and fixing typos.