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

Readme tweaks #patch #78

Merged
merged 11 commits into from
Nov 19, 2024
Merged

Readme tweaks #patch #78

merged 11 commits into from
Nov 19, 2024

Conversation

ll-nick
Copy link
Collaborator

@ll-nick ll-nick commented Nov 19, 2024

This

  • tidies up the readme by using spoilers
  • adds links when clicking the badges
  • adds a citation section
  • adds short instructions on installing from zip/tar
  • adds a contributors section

@ll-nick ll-nick requested a review from orzechow November 19, 2024 08:05
@ll-nick ll-nick self-assigned this Nov 19, 2024
@ll-nick
Copy link
Collaborator Author

ll-nick commented Nov 19, 2024

Would you also like to link your IV paper @orzechow ?

Copy link
Member

@orzechow orzechow left a comment

Choose a reason for hiding this comment

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

Great!

  • Some suggestions regarding the citations.
  • Also, I added short instructions on installing from zip/tar in a9cc9b0
  • Added contributors section in 31fca68 (assuming you improve your LinkedIn profile URL 😉 )
  • Some tweaks in 31fca68...0d78b28

Please consider my suggestions and merge if you're happy with the result.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@orzechow
Copy link
Member

Alright, after e2eebd1 this is ready to merge 😁

@ll-nick ll-nick merged commit a70465c into main Nov 19, 2024
1 check passed
@ll-nick ll-nick deleted the readme_tweaks branch November 19, 2024 15:20
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