Streamline README.md

Merged, abandoned or rejected pull requests are moved here to clear the main Pull Requests forum.
Post Reply
User avatar
kkremitzki
Veteran
Posts: 2515
Joined: Thu Mar 03, 2016 9:52 pm
Location: Illinois

Streamline README.md

Post by kkremitzki »

https://github.com/FreeCAD/FreeCAD/pull/451

Take a look at the screenshot from my Add gitter.im badge PR here.

That screenshot made me notice two things. First, that list of "resource: URL" items could be made much easier on the eyes by using Markdown links; it's very obvious that they are hyperlinks in Github. It wouldn't hurt to make them bulleted lists either, since that's what they are. I went through the README and converted (in my opinion) rough on the eyes URLs to proper links.

Second, the general content needed a bit of a revision. For example, from that screenshot, note:
The FreeCAD documentation wiki contains a lot of documentation...
Could be phrased better.

There were a few other consistency and tone changes I made; some things didn't sound too natural. Also the document had both OpenCasCADE and OpenCasCade, but I believe it's either OpenCASCADE or Open CASCADE. So I updated that for consistency as well.

For easy, rendered comparison:
Old
New
I think the "new" look is significantly cleaner.
Like my FreeCAD work? I'd appreciate any level of support via Patreon, Liberapay, or PayPal! Read more about what I do at my blog.
User avatar
sgrogan
Veteran
Posts: 6499
Joined: Wed Oct 22, 2014 5:02 pm

Re: Streamline README.md

Post by sgrogan »

kkremitzki wrote:lso the document had both OpenCasCADE and OpenCasCade, but I believe it's either OpenCASCADE or Open CASCADE. So I updated that for consistency as well.
It seems they are a little inconstant themselves. On the home page "OPEN CASCADE" elsewhere on the site "Open CASCADE" https://www.opencascade.com/content/download-center
I do like the bullets.
"fight the good fight"
User avatar
kkremitzki
Veteran
Posts: 2515
Joined: Thu Mar 03, 2016 9:52 pm
Location: Illinois

Re: Streamline README.md

Post by kkremitzki »

My impression was that OPEN CASCADE is the company and Open CASCADE Technology or OpenCASCADE is the tech. Check out https://www.opencascade.com/content/company versus your link.
Like my FreeCAD work? I'd appreciate any level of support via Patreon, Liberapay, or PayPal! Read more about what I do at my blog.
User avatar
sgrogan
Veteran
Posts: 6499
Joined: Wed Oct 22, 2014 5:02 pm

Re: Streamline README.md

Post by sgrogan »

kkremitzki wrote:My impression was that OPEN CASCADE is the company and Open CASCADE Technology or OpenCASCADE is the tech. Check out https://www.opencascade.com/content/company versus your link.
Consistency is most important, beyond that it's nickpicky stuff. I'd vote for Open CASCADE Technology hence the OCCT acronym. Distinguishable from oce the community fork based on the same work.
"fight the good fight"
Post Reply