1587650 - WebRender's README.md is incomplete

Status: RESOLVED FIXED

(Core :: Graphics: WebRender, enhancement, P3)

Description

[skierpage]

https://github.com/servo/webrender/blob/master/README.md says

GPU renderer for the Web content, used by Servo.

But...

• it's also used by Firefox
• as I understand it it renders the browser's GUI as well as "web content"
• it's also used by the Azul GUI framework
• it currently uses the OpenGL API

The Mozilla GFX Team blog has a better sentence:
WebRender is a GPU based 2D rendering engine for web written in Rust, currently powering Firefox‘s rendering engine as well as the research web browser servo.

FWIW, https://crates.io/crates/webrender uses the description from its Cargo.toml

A GPU accelerated 2D renderer for web content

I'll attempt a pull request on GitHub.

Comment 1

[skierpage]

(In reply to skierpage from comment #0)

I'll attempt a pull request on GitHub.

https://github.com/servo/webrender/pull/3772 and ? https://reviewable.io/reviews/servo/webrender/3772 ; hope this helps, edit away.
Sorry I'm not "familiar with the mozilla-central contribution workflow," that line in the README could use a link, is the workflow now https://moz-conduit.readthedocs.io/en/latest/walkthrough.html ?

Comment 2

[Kris Taeleman (:ktaeleman)]

Thanks for the contributions!
@gw: Could you take a look at these pull requests?

Comment 3

[Glenn Watson [:gw]]

I'm not exactly sure what the process is for landing PRs now - I can take a look when back from PTO, or kvark may be able to sort it in the meantime.

Comment 4

[Dzmitry Malyshau [:kvark]]

Attachment: Update README.md with more informative intro

Addresses issues with the README in mozilla bug 1587650.
[import_pr] From https://github.com/servo/webrender/pull/3772

Comment 5

[Dzmitry Malyshau [:kvark]]

FYI, it starts with ./mach import-pr https://github.com/servo/webrender/pull/3772 (given no local changes) and then goes as usual.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/fc99c7377948
Update README.md with more informative intro r=gw

Comment 7

[Andrei Ciure[:aciure]]

https://hg.mozilla.org/mozilla-central/rev/fc99c7377948