Bug 168413 – Add ReadMe.md to WebKit

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[Ryosuke Niwa]

Add a readme file to https://github.com/WebKit/webkit.

[Ryosuke Niwa]

Created attachment 301709 [details]
Adds a ReadMe.md.

[Wenson Hsieh]

Comment on attachment 301709 [details]
Adds a ReadMe.md.

View in context: https://bugs.webkit.org/attachment.cgi?id=301709&action=review

> ReadMe.md:51
> +WebKit has multiple ports such as Mac, iOS, Windows, GTK+, and EFL. The following instruction is for building WebKit on Mac. For other ports, following the instructions on our website:

How about: "The following instructions are for building WebKit on Mac. For other ports, follow these instructions on our website:"

> ReadMe.md:111
> +The `run-safari` script sets the `DYLD_FRAMEWORK_PATH` environment variable to point to your build products, and then launches `/Applications/Safari.app`. `DYLD_FRAMEWORK_PATH`tells the system loader to prefer your build products over the frameworks installed in `/System/Library/Frameworks`.

Nit - space between `DYLD_FRAMEWORK_PATH` and tells

[Joseph Pecoraro]

Comment on attachment 301709 [details]
Adds a ReadMe.md.

View in context: https://bugs.webkit.org/attachment.cgi?id=301709&action=review

> ChangeLog:10
> +        * ReadMe.md: Added.

I think README.md more canonical than ReadMe.md. I would strongly suggest all uppercase.

[Ryosuke Niwa]

Created attachment 301713 [details]
Patch

[Alex Christensen]

Comment on attachment 301713 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=301713&action=review

> ReadMe.md:55
> +* [EFL](https://trac.webkit.org/wiki/EFLWebKit)

Let's remove this.  See https://lists.webkit.org/pipermail/webkit-dev/2017-February/028730.html

> ReadMe.md:127
> +In both cases, if you have built release builds instead, use `--release` instead of `--debug`.\

Is the \ after the . intentional?

[Ryosuke Niwa]

(In reply to comment #5)
> Comment on attachment 301713 [details]
> Patch
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=301713&action=review
> 
> > ReadMe.md:55
> > +* [EFL](https://trac.webkit.org/wiki/EFLWebKit)
> 
> Let's remove this.  See
> https://lists.webkit.org/pipermail/webkit-dev/2017-February/028730.html

Removed.

> > ReadMe.md:127
> > +In both cases, if you have built release builds instead, use `--release` instead of `--debug`.\
> 
> Is the \ after the . intentional?

No. Fixed.

[Ryosuke Niwa]

Created attachment 301832 [details]
Patch

[Chris Dumez]

Comment on attachment 301832 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=301832&action=review

> ReadMe.md:75
> +If you don't use a custom build location in Xcode preferences, you have to update the workspace settings to use `WebKitBuild` directory.  In menu bar, choose File > Workspace Settings, then click the Advanced button, select âCustomâ, âRelative to Workspaceâ, and enter `WebKitBuild` for both Products and Intermediates.

We should probably avoid non-ascii characters.

> ReadMe.md:85
> +Without this step, you will see the error message: â`target specifies product type âcom.apple.product-type.toolâ, but thereâs no such product type for the âiphonesimulatorâ platform.`â when building target `JSCLLIntOffsetsExtractor` of project `JavaScriptCore`.

We should probably avoid non-ascii characters.

> ReadMe.md:130
> +Congratulations! Youâre up and running. Now you can begin coding in WebKit and contribute your fixes and new features to the project. For details on submitting your code to the project, read [Contributing Code](https://webkit.org/contributing-code/).

We should probably avoid non-ascii characters.

[Chris Dumez]

Comment on attachment 301832 [details]
Patch

Did you see my comments?

[Ryosuke Niwa]

(In reply to comment #9)
> Comment on attachment 301832 [details]
> Patch
> 
> Did you see my comments?

Oh weird, somehow I didn't see them earlier. Will fix.

[Ryosuke Niwa]

Committed in r212790.