update readme - Githubissues

QEDjl-project / QEDbase.jl

[WIP] Base types and interfaces for QED.jl

https://qedjl-project.github.io/QEDbase.jl/stable/

MIT License

5 stars 5 forks source link

update readme #10

Open szabo137 opened 1 year ago

szabo137 commented 1 year ago

The readme seems to be outdated.

[ ] fix the broken badges at the beginning of the README
[ ] update the contributor section
[ ] fix broken links
[ ] fix typos (thanks @AlexanderJCS) for mentioning

szabo137 commented 3 months ago

@AlexanderJCS wrote

When reading the README.md file, I noticed that there was a small typo in the word "contributor". It is spelled "contributer". It is spelt incorrectly two times:
## Credits and contributers
and:
- the guy who will show me how to include the most recent contributers on github
This seems parallel to issue #10 which proposes to update the contributors section entirely.

Thanks for filing this issue, we will take care of it here.