Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor edits to README.md #44

Merged
merged 3 commits into from
Nov 6, 2018
Merged

Minor edits to README.md #44

merged 3 commits into from
Nov 6, 2018

Conversation

jwharrie
Copy link
Contributor

@jwharrie jwharrie commented Nov 6, 2018

"Rusts" --> "Rust's" (in the "Programming Model" section)
Edited the first paragraph for more clarity. I think you were saying that Azul supports development of desktop apps that were written in Rust AND were supported by the Mozilla WebRender rendering engine, but the original sentence was unclear about that. I rewrote that part and then wrote about Azul using a CSS/DOM model in a separate sentence. It's to be clear that Azul uses the model, not the desktop apps (if that was what you meant).

Fixes #43

"Rusts" --> "Rust's" (in the "Programming Model" section)
Edited the first paragraph for more clarity. I think you were saying that Azul supports development of desktop apps that were written in Rust AND were supported by the Mozilla WebRender rendering engine, but the original sentence was unclear about that. I rewrote that part and then wrote about Azul using a CSS/DOM model in a separate sentence. It's to be clear that Azul uses the model, not the desktop apps (if that was what you meant).
@coveralls
Copy link

coveralls commented Nov 6, 2018

Pull Request Test Coverage Report for Build 573

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 441 unchanged lines in 8 files lost coverage.
  • Overall coverage increased (+75.4%) to 75.49%

Files with Coverage Reduction New Missed Lines %
src/text_cache.rs 2 0.0%
src/css.rs 3 94.44%
src/default_callbacks.rs 6 60.87%
src/id_tree.rs 13 92.73%
src/dom.rs 50 75.0%
src/ui_solver.rs 66 83.58%
target/debug/build/glium-cc3f82791ed2ac9f/out/gl_bindings.rs 109 48.05%
src/css_parser.rs 192 72.84%
Totals Coverage Status
Change from base Build 568: 75.4%
Covered Lines: 2042
Relevant Lines: 2705

💛 - Coveralls

@fschutt
Copy link
Owner

fschutt commented Nov 6, 2018

Yeah but the applications do use CSS and a DOM model... I mean just look at the examples, they all use a DOM and a CSS stylesheet.

I think you were saying that Azul supports development of desktop apps that were written in Rust AND were supported by the Mozilla WebRender rendering engine,

In my sentence the "supported by the Mozilla WebRender rendering engine" clearly refers to the framework, but your sentence sounds like you have to already have to have an existing application using WebRender or directly use WebRender in your application, which is not the case. Azul uses WebRender, yeah, therefore all applications using Azul also use WebRender. But that is implied by saying that the framework uses WebRender - so if you use the framework, then you use WebRender, obviously.

And if you want to change it to two sentences, you might as well remove that sentence, since it's more or less the "tagline" of Azul, which is usually the project summed up in one sentence.

So overall I think the sentence is correct and you just misunderstood the architecture of the framework - applications that use Azul use a CSS and DOM model, because that's the API exposed by the framework. Your application doesn't use WebRender directly, Azul uses WebRender. And yes, applications do use a DOM and CSS model to do layout and styling.

Maybe "built on top of" instead of "supported by" is more clear, since "supported" can mean many things - Azul is built on top of WebRender.

Rewrote the first sentence to make it one sentence again and to make it more accurate.
@jwharrie
Copy link
Contributor Author

jwharrie commented Nov 6, 2018

I took your feedback and rewrote it again. I hope it helps.

@fschutt
Copy link
Owner

fschutt commented Nov 6, 2018

Well now it's just the original sentence again but without commas forming a bandworm sentence. "Utilizing the Mozilla WebRender rendering engine for rapid development" sounds like the rapid development is due to WebRender, not due to Azul.

My suggestion would be to leave the original sentence alone and just change "supported by the Mozilla WebRender rendering engine" to "built on top of the Mozilla WebRender rendering engine".

Change "utilizing" to "built on."
@jwharrie
Copy link
Contributor Author

jwharrie commented Nov 6, 2018

I made it more clear that Azul is built on WebRender.
If we went back to the original sentence it would seem weird to describe what Azul is built on while in the middle of describing what Azul is used on. It would be better to group together the information describing the Azul framework itself, then describe the function of Azul.

@fschutt fschutt merged commit 87baf05 into fschutt:master Nov 6, 2018
@fschutt
Copy link
Owner

fschutt commented Nov 6, 2018

Yeah, maybe in the future I should leave out mentioning WebRender entirely. But thanks for looking over it, I think it's fine for now.

fschutt added a commit that referenced this pull request May 13, 2019
Typo corrections & slight rewording in README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants