search

miraisolutions / compareWith

RStudio Addins for Enhanced Diff and Merge
55 stars 11 forks source link

Improved README / animated GIF #12

Closed riccardoporreca closed 5 years ago

riccardoporreca commented 5 years ago

General review of README

Animated GIF as outlined in #9.

@fvitalini should advise on reviewing / improving the MacOS part.

fvitalini commented 5 years ago

Meld is not yet officially supported for macOs ( reference http://meldmerge.org ) OS X builds are provided on the meld website. Additionally, Meld is available from MacPorts, Fink or Brew, but according to the meld website none of these methods are supported.

fvitalini commented 5 years ago

As a personal comment, in the gif it is unclear how the conflicts are resolved. Maybe a couple of more frames? Also a final screenshot that clearly marks the end of the gif before it restarts would be nice.

riccardoporreca commented 5 years ago

@fvitalini

As a personal comment, in the gif it is unclear how the conflicts are resolved. Maybe a couple of more frames?

The GIF currently does not show the resolution of the conflict but only how to get to the Meld merge view. The focus is not really to show how to resolve this specific conflict but how you get to a tool / view you can use to resolve conflicts.

Showing the final resolved status was the idea of the final step mentioned in #9. However this final step might be hard to recorded live in one go, since the conflict resolution is manual and maybe not easy / worth showing in a GIF demo (it would be quite a few more frames). We could try to transition to a screenshot showing the final resolution if it helps. I could speed up the manual conflict resolution relying on keyboard shortcuts, and it indeed it adds a lot of value to see the whole merge conflict workflow! See f5f6602.

Also a final screenshot that clearly marks the end of the gif before it restarts would be nice.

As for the restart, I have added a progressive blur of the last frame in c4a24fb.

Note that this process can be sort of automated and I will document it as part of #9

fvitalini commented 5 years ago

The new version of the gif is nicer and more informative. Considering that the commands for installing Meld via brew are standard Homebrew commands, and that we do not have the equivalent for MacPorts and Fink, it makes sense to remove them and point to the Meld website https://wiki.gnome.org/Apps/Meld/OSX

riccardoporreca commented 5 years ago

[...] it makes sense to remove them and point to the Meld website https://wiki.gnome.org/Apps/Meld/OSX

I actually checked and that wiki is pretty outdated (2015-01-21), so I am not including the link in the reviewed MacOs part in 1067a40 and 00be8e1.

riccardoporreca commented 5 years ago

Note that Title and Description in the DESCRIPTION file have also been updated in c7187b1.

riccardoporreca commented 5 years ago

Upon merge into master (shortly after this pull request to develop), we probably want to align the repo description image to the new title in README title (RStudio Diff / Merge Addins with VCS Capabilities)