Major overhaul of README so other people can build successfully #157
Conversation
…mation each quarter
…d differently in the README
There was a problem hiding this comment.
This is a solid step forward but could still use some refinement to simplify the text and make the process super clear. In particular, when I got to the pieces about callouts, I felt like I hadn't been given info initial information to understand what the steps were about and the overall scope of that section.I am requesting change because I would like you to give it a close read through again to try and reduce wordiness and be direct with the instructions. I appreciate the insight provided on different pieces that may need to be iterated on, troubleshooted, and other known caveats and suggest using a consistent format for those sections.
README.md
Outdated
| ### Tweak event callout timing and appearance | ||
|
|
||
| This is usually where I spend the most hands-on time because it is where you iterate on how the callouts integrate with the animation. Usually, the first animation is not ready for publication because callouts may overlap each other visually or temporally, some may extend the full length of the animation which isn't very useful, and others may blip on and then off too quickly for a user to read. Below we detail the other attributes and methods that you can use to polish the final visualization. |
There was a problem hiding this comment.
This feels like it should come sooner to explain what's happening in the process.
There was a problem hiding this comment.
These elements will have defaults based on the callout_cfg.yml. I think this is the appropriate place for this information because you should build the animation once all the way through using the callout defaults before deciding how to tweak them.
| # To make absolutely sure that your video will use the right font, you may need to run: | ||
| sysfonts::font_add_google('Abel','abel') | ||
| * `6_visualize/out/river_conditions_[month start]_[month end]_[year]_twitter.mp4` | ||
| * `6_visualize/out/river_conditions_[month start]_[month end]_[year]_visid.mp4` |
There was a problem hiding this comment.
what is the difference between visid and the social media versions? we should have visId on all of them, so maybe it is not needed to have a separate version for that, rather be a part of all versions. This comment is coming from an uninformed place and maybe is irrelevant
There was a problem hiding this comment.
Visid is the black bar across the bottom. We have been releasing on social media without that requirement, but including on the video on Drupal
Co-authored-by: Cee Nell <[email protected]>
The quarterly build of this animation will be moving over to others in Vizlab. Here is my big overhaul of the README to braindump things that I just knew how to do but didn't spend much time documenting before now. Wheeeeeee documentation!
See what this README looks like now by visiting my fork at https://github.com/lindsayplatt/gage-conditions-gif/tree/update_instructions#gage-conditions