miso-sound / misosoupy

Misophonia Stimulus Organization Using Python
MIT License
0 stars 0 forks source link

More updates to README #26

Closed danibene closed 1 month ago

danibene commented 1 month ago

This PR removes the scaling of an image in the README which seemed to cause issues publishing on PyPI, as well as removes the links to the readthedocs page which currently isn't working.

I also removed a note in the contributing guide that I just noticed and thought was unnecessary.

danibene commented 1 month ago

@hansen508 this is what the image looks like at 500px: https://github.com/miso-sound/misosoupy/tree/f1a26630b77d22f353928b4126e402bf2417e6d5?tab=readme-ov-file#examples

Screenshot 2024-09-16 at 7 06 31 AM

I think I will just remove the image width specifier for now to make it consistent with the others but feel free to update.

hansen508 commented 1 month ago

@danibene Yup, totally fine to just remove width specifier, especially if it's causing issues with PyPI

And weird about the readthedocs link not working, but I'm not sure I know enough to understand why. So I'm down to remove that too.

Feel free to merge when you're ready!