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

Update README.md #4307

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #4307

wants to merge 1 commit into from

Conversation

wenqingl
Copy link

@wenqingl wenqingl commented Jul 25, 2022

This README is great but I made some comments on the grammar

are build scripts that download and compile the libraries from source.
Follow the instructions for the platform you're compiling on below.
are build scripts that download and compile the libraries from the source.
Follow the instructions for the platform you're compiling below.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we compiling the platform? I think the current wording is better here, we are compiling OpenSCAD on the platform of choice.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think "compiling from source" is a common term in software dev, even though it may not be 100% correct language wise (not an expert on that :) )

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Follow the instructions below for the platform you're compiling on" might be better, avoiding the strange "on below" sequence.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the comments, this helps me as non-native speaker. @wenqingl would you mind updating the PR with the suggested changes (or give an argument for keeping the original version)?

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.

None yet

4 participants