-
Notifications
You must be signed in to change notification settings - Fork 178
Added documentation about the Qt Creator export #146
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
Conversation
@AnotherButler Could you edit this when you get a chance? |
Thanks @cvtsi2sd for adding also docs! |
@0xc0170 well, it didn't really take long 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice use of semicolons. I left one comment with a suggested change.
docs/advanced/exporters.md
Outdated
|
||
The Qt Creator project export is available for the GCC_ARM toolchain; it generates a [Qt Creator generic project](http://doc.qt.io/qtcreator/creator-project-generic.html) and a Makefile, in a similar fashion to the *Eclipse and Make* exporter. | ||
|
||
The generated `.creator` project can be opened in Qt Creator, enabling integration with the project pane, syntax highlighting and automatic code completion; the Makefile can be used to actually compile the project, and should be automatically called by the IDE when the Build command is issued. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is in passive voice, and our style is to use active voice. I would like to change this active voice, but I do not want to accidentally change the meaning. Would it be correct to change this to the following?
"You can open the generated .creator
project in Qt Creator, enabling integration with the project pane, syntax highlighting and automatic code completion. You can use the Makefile to compile the project; the IDE automatically calls the Makefile when you issue the Build command."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That should be fine, although I'd leave the "should" in the Makefile bit ("the IDE should automatically call..."), because it seems to be merely a default setting, which I don't know if is contractual.
I changed the sentence from passive to active; sorry, I actually did it last week but forgot to commit. 😴 |
Thanks for taking the time to update this. We appreciate it. :) |
As per title; see the mbed-os pull request 4115.