Bug 168413 - Add ReadMe.md to WebKit
Summary: Add ReadMe.md to WebKit
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Tools / Tests (show other bugs)
Version: Other
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: Ryosuke Niwa
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-02-15 22:08 PST by Ryosuke Niwa
Modified: 2017-02-21 18:18 PST (History)
6 users (show)

See Also:


Attachments
Adds a ReadMe.md. (6.25 KB, patch)
2017-02-15 22:10 PST, Ryosuke Niwa
no flags Details | Formatted Diff | Diff
Patch (6.18 KB, patch)
2017-02-15 22:51 PST, Ryosuke Niwa
no flags Details | Formatted Diff | Diff
Patch (6.15 KB, patch)
2017-02-16 14:59 PST, Ryosuke Niwa
cdumez: review+
Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ryosuke Niwa 2017-02-15 22:08:55 PST
Add a readme file to https://github.com/WebKit/webkit.
Comment 1 Ryosuke Niwa 2017-02-15 22:10:21 PST
Created attachment 301709 [details]
Adds a ReadMe.md.
Comment 2 Wenson Hsieh 2017-02-15 22:23:00 PST
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
Comment 3 Joseph Pecoraro 2017-02-15 22:31:43 PST
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.
Comment 4 Ryosuke Niwa 2017-02-15 22:51:59 PST
Created attachment 301713 [details]
Patch
Comment 5 Alex Christensen 2017-02-16 08:51:32 PST
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?
Comment 6 Ryosuke Niwa 2017-02-16 14:55:15 PST
(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.
Comment 7 Ryosuke Niwa 2017-02-16 14:59:03 PST
Created attachment 301832 [details]
Patch
Comment 8 Chris Dumez 2017-02-21 17:14:45 PST
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.
Comment 9 Chris Dumez 2017-02-21 17:28:00 PST
Comment on attachment 301832 [details]
Patch

Did you see my comments?
Comment 10 Ryosuke Niwa 2017-02-21 18:07:07 PST
(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.
Comment 11 Ryosuke Niwa 2017-02-21 18:18:56 PST
Committed in r212790.