[webkit-dev] ReadMe.md on Github

[Ryosuke Niwa]

On Wed, Feb 22, 2017 at 6:55 AM, Michael Catanzaro
<mcatanzaro at igalia.com> wrote:
> On Tue, 2017-02-21 at 22:53 -0800, Ryosuke Niwa wrote:
>> I feel like GTK+ port's instruction can be consolidated enough to fit
>> there but we might want to write some script that someone can run to
>> do everything you need like Tools/Scripts/configure-xcode-for-ios-
>> development for iOS first.
>
> Currently there are just two scripts (install-dependencies and update-
> webkitgtk-libs), and they are sufficiently-different that they should
> not be consolidated.

Oh, I didn't realize you just had to run two scripts. We should just
add GTK+ instruction then.

> That said, a pointer from the README to somewhere else is fine for us.
> Certainly that's the way to go if the goal is to reduce the size of the
> README. I would go as far to remove the Mac/iOS build and run
> instructions and just point to the website for all ports. The more
> content we duplicate in the README, the more content we have that will
> get out of sync with the website.

Well, the point of adding ReadMe.md was to consolidate information
needed to start hacking on WebKit without having to read dozens of web
pages.

However, in general, it's a good idea to make it as brief as possible
so that it won't result in TL; DR.

- R. Niwa