Re: [webkit-dev] ReadMe.md on Github

[Ryosuke Niwa]

Posted a patch on https://bugs.webkit.org/show_bug.cgi?id=168745 to
add instructions to build GTK+ port.
- R. Niwa


On Wed, Feb 22, 2017 at 2:26 PM, Ryosuke Niwa  wrote:
> On Wed, Feb 22, 2017 at 6:55 AM, Michael Catanzaro
>  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
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] ReadMe.md on Github

[Ryosuke Niwa]

On Wed, Feb 22, 2017 at 6:55 AM, Michael Catanzaro
 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
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] ReadMe.md on Github

[Michael Catanzaro]

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.

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.

Michael
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] ReadMe.md on Github

[Konstantin Tokarev]

  22.02.2017, 10:18, "Brian Burg" : On Feb 21, 2017, at 10:53 PM, Ryosuke Niwa  wrote: Hi, I recently added ReadMe.md file to WebKit's top-level directory for the convenience of Github users: https://github.com/WebKit/webkit I've added a very abridged instruction on how to checkout & build WebKit for Mac/iOS ports for simplicity. It would be great if we can trim down the amount of information further. 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. Let me know what you think of it, and please feel free to post a patch to improve it! This is really great Ryosuke, thanks for your work! We may want to consider a similar consolidation of the Trac Wiki, which is sprawling, mostly outdated, hard to use, and hostile to new developers/passersby.  I think it's a FUD. Also note that on Github wiki is open for editing either for everyone, or for contributors of repo that are given write access.  - R. Niwa___webkit-dev mailing listwebkit-dev@lists.webkit.orghttps://lists.webkit.org/mailman/listinfo/webkit-dev,___webkit-dev mailing listwebkit-dev@lists.webkit.orghttps://lists.webkit.org/mailman/listinfo/webkit-dev  -- Regards,Konstantin ___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] ReadMe.md on Github

[Brian Burg]

> On Feb 21, 2017, at 10:53 PM, Ryosuke Niwa  wrote:
> 
> Hi,
> 
> I recently added ReadMe.md file to WebKit's top-level directory for the 
> convenience of Github users: https://github.com/WebKit/webkit 
> 
> 
> I've added a very abridged instruction on how to checkout & build WebKit for 
> Mac/iOS ports for simplicity. It would be great if we can trim down the 
> amount of information further.
> 
> 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.
> 
> Let me know what you think of it, and please feel free to post a patch to 
> improve it!

This is really great Ryosuke, thanks for your work! We may want to consider a 
similar consolidation of the Trac Wiki, which is sprawling, mostly outdated, 
hard to use, and hostile to new developers/passersby.

> 
> - R. Niwa
> ___
> webkit-dev mailing list
> webkit-dev@lists.webkit.org
> https://lists.webkit.org/mailman/listinfo/webkit-dev

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

[webkit-dev] ReadMe.md on Github

[Ryosuke Niwa]

Hi,

I recently added ReadMe.md file to WebKit's top-level directory for the
convenience of Github users: https://github.com/WebKit/webkit

I've added a very abridged instruction on how to checkout & build WebKit
for Mac/iOS ports for simplicity. It would be great if we can trim down the
amount of information further.

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.

Let me know what you think of it, and please feel free to post a patch to
improve it!

- R. Niwa
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev