-
Notifications
You must be signed in to change notification settings - Fork 137
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
content: publish zephyr basics article #417
Conversation
Also tweaks the title and adds some grammar changes.
@lmapii I did a grammar pass and tweaked the title a bit. Let me know what you think. |
@@ -70,50 +70,50 @@ This is where the journey **ends**. After this series, you should find it easy - | |||
|
|||
## Prerequisites | |||
|
|||
In general, you should be familiar with embedded software since we won't cover the basics. Some knowledge in using build systems such _CMake_ doesn't hurt but is not necessary. In case you don't know at all what Zephyr is, have a short look at the [introduction in the official documentation](https://docs.zephyrproject.org/latest/introduction/index.html). | |||
You should be familiar with embedded software since we won't cover the basics. Some knowledge in using build systems such _CMake_ doesn't hurt but is unnecessary. If you don't know what Zephyr is, look briefly at the [introduction in the official documentation](https://docs.zephyrproject.org/latest/introduction/index.html). |
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.
Just for myself as non-native speaker: Doesn't "unnecessary" sound harsh or mean that it is "never" needed or superfluous? E.g., here: CMake knowledge is for sure helpful but simply not needed to understand the article.
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.
Hm agree that unnecessary doesn't quick hit the mark here. Maybe "not required" flows better.
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.
Agreed unnecessary is a little extreme. I'll switch to not required
|
||
|
||
|
||
## Creating an empty application skeleton | ||
|
||
Now that we have a working installation, we can start with the important parts of this article series. Before creating our first files, let's review Zephyr's supported application _types_. | ||
Now that we have a working installation, we can start with the important parts of this article series. Before creating our first files, review Zephyr's supported application _types_. |
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.
Here I'd maybe keep the "let's" or phrase it differently since otherwise it sounds like an instruction for the reader (and the "review" is performed in the subsequent sections).
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.
Good call, definitely a better read this way.
@@ -429,18 +429,18 @@ manifest.file=west.yml | |||
zephyr.base=zephyr | |||
build.board=nrf52840dk_nrf52840 | |||
# It is also possible to delete an option | |||
# e.g., using `west config -d build.board` | |||
#, e.g., using `west config -d build. board` |
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 should really be build.board
.
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.
Ooops not sure what happened here. Maybe an autoformat.
Thanks! @bahildebrand just a couple of remarks and one for my understanding :) |
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.
A couple small details. Looks great! Excited for this one.
@@ -70,50 +70,50 @@ This is where the journey **ends**. After this series, you should find it easy - | |||
|
|||
## Prerequisites | |||
|
|||
In general, you should be familiar with embedded software since we won't cover the basics. Some knowledge in using build systems such _CMake_ doesn't hurt but is not necessary. In case you don't know at all what Zephyr is, have a short look at the [introduction in the official documentation](https://docs.zephyrproject.org/latest/introduction/index.html). | |||
You should be familiar with embedded software since we won't cover the basics. Some knowledge in using build systems such _CMake_ doesn't hurt but is unnecessary. If you don't know what Zephyr is, look briefly at the [introduction in the official documentation](https://docs.zephyrproject.org/latest/introduction/index.html). |
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.
Hm agree that unnecessary doesn't quick hit the mark here. Maybe "not required" flows better.
Also tweaks the title and adds some grammar changes.