search

JMSLab / xtevent

Stata package -xtevent-
MIT License
43 stars 12 forks source link

Animation for Github readme #87

Open jorpppp opened 2 years ago

jorpppp commented 2 years ago

I think it would be cool to have an animation like this one in our Github home page:

https://www.statalist.org/forums/forum/general-stata-discussion/general/1627508-xtevent-stata-module-to-estimate-and-visualize-linear-panel-event-study-models-now-available-on-ssc

@rayhuang11 @Constantino-Carreto-Romero what do you think?

If you like the idea, @rayhuang11 can you look into how to include an animation like this in readme.md, please?

rayhuang11 commented 2 years ago

@jorpppp the animation seems to be saved as a gif file?

My thoughts are it could be helpful to have, and it might make usage easier for some users. The argument it against it is that it takes a lot of space and the current readme is already quite clear. So I think adding it would be fine, and not adding it would be perfectly okay as well.

If we decide to proceed, I can look deeper into this. For now, I'm assuming the animation on statalist is in gif format. If so, we can easily include a gif in the GitHub homepage. See here for more info.

Constantino-Carreto-Romero commented 2 years ago

I think the animation could be useful to catch the attention of the users, but in what part of the readme should it be placed? maybe somewhere before or after the examples.

rayhuang11 commented 2 years ago

@Constantino-Carreto-Romero since it's kinda bulky, I was thinking the end of the readme?

Constantino-Carreto-Romero commented 2 years ago

@rayhuang11 I agree, it would be good to place it there

jorpppp commented 2 years ago

@jorpppp will look in his computer to see how he made the animation and post it here for @rayhuang11 to follow up. Maybe there's a better way, or maybe that way will work. Then @rayhuang11 will record a new, smaller animation that we can place at the end of the readme.md file.

jorpppp commented 2 years ago

This is not a first priority so I'll unassign myself from now.