search

miso-sound / misosoupy

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

update README with examples #17

Closed hansen508 closed 1 month ago

hansen508 commented 1 month ago

Okay, admittedly this is kind of an eyesore with probably too much file-embedding, but I've added some additional documentation with examples!

Couple specific questions I'd like your feedback on:

  1. How to reduce image size onscreen? They def don't need to take up the full width. I haven't been able to figure out an easy way to do this through code (at least in restructured text), but can keep googling or manipulate outside of Git otherwise
  2. Where best to store demo screenshots/gifs? Right now I plopped them into ./docs/media/, but please move them if they make more sense elsewhere
  3. Are there too many examples, or images that are unnecessary? Or, alternatively, other things you'd like a depiction of?
hansen508 commented 1 month ago

Okay, I think I fixed the thing that was causing the tests to fail (and merged it in another pull request). Is it possible to rerun the tests? @danibene

danibene commented 1 month ago

Okay, admittedly this is kind of an eyesore with probably too much file-embedding, but I've added some additional documentation with examples!

Couple specific questions I'd like your feedback on:

  1. How to reduce image size onscreen? They def don't need to take up the full width. I haven't been able to figure out an easy way to do this through code (at least in restructured text), but can keep googling or manipulate outside of Git otherwise

I think you could try specifying the width e.g. :width: 500px without the scale.

  1. Where best to store demo screenshots/gifs? Right now I plopped them into ./docs/media/, but please move them if they make more sense elsewhere

Seems like a good place!

  1. Are there too many examples, or images that are unnecessary? Or, alternatively, other things you'd like a depiction of?

I think the GIFs are awesome! I wonder if we should give more specific installation instructions. Do we want to put this on PyPi?

danibene commented 1 month ago

Okay, I think I fixed the thing that was causing the tests to fail (and merged it in another pull request). Is it possible to rerun the tests? @danibene

You did this on the add/documentation branch which you then merged to dev, so I ran git merge dev to merge those changes into the update/README branch