-
Notifications
You must be signed in to change notification settings - Fork 3k
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
[NRF5] documnetation - readme file for nRF5x bases targets #3453
[NRF5] documnetation - readme file for nRF5x bases targets #3453
Conversation
@@ -0,0 +1,55 @@ | |||
# Nordic platform's readme |
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.
Nit: should this file be named Readme.me instead of ReadMe.md ?
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.
ok, for windows no difference since it is blind...
I will change to (the most popular in mbed-os) README.md
@nvlsianpu @pan- any updates or things left to do here? |
I rebased this. |
|
||
Nordic provides several development kit targets, called *[base target]*. For example: | ||
- NRF51_DK | ||
- NRF51_DK_LEGACY |
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.
Is it necessary to mention the legacy target ?
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.
TBR
- NRF51_DK_LEGACY | ||
- NRF52_DK | ||
- NRF51_DONGLE | ||
- others are incoming as mbed-os is under continuous construction! |
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.
Is it possible to rephrase this sentence in something more positive. It sound like mbed is a loosy product and will always be. Maybe indicate that Nordic supports mbed and will add new targets when new development kits are released.
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.
Nordic continuously supports mbed and other targets will become available with releases of new Nordic development kits.
?
- NRF51_DONGLE | ||
- others are incoming as mbed-os is under continuous construction! | ||
|
||
For most of Nordic�s development kits, a few versions of the targets are provided: |
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.
What do you think of replacing few versions
by three flavors
.
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 hint, ok.
- NRF52_DK | ||
- NRF51_DONGLE | ||
- others are incoming as mbed-os is under continuous construction! | ||
|
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.
Is it possible to add another section here for FOTA instead of having everything grouped under Nordic’s development kit targets
?
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.
##2 Regular and FOTA targets types
For most of nRF5x SoC development kits, a few versions of the targets are provided:
...
@pan- can you please review update? |
Great, thanks @pan-! |
Description
The doc. contains some useful hints and clarifications for end users:
This doc will be linked form nordic's mbed targets boards webs
Status
HOLD
Related PRs
merge it after #3376