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

[NRF5] documnetation - readme file for nRF5x bases targets #3453

Merged
merged 6 commits into from
Jan 13, 2017

Conversation

nvlsianpu
Copy link
Contributor

Description

The doc. contains some useful hints and clarifications for end users:

  • targets intended to standard build and FOTA build,
  • bootloader selection mechanism, links to bootloader descriptions
  • uart flow control configuration mechanism
  • link to low frequency clock configuration description (already provided in mbed-os)

This doc will be linked form nordic's mbed targets boards webs

Status

HOLD

Related PRs

merge it after #3376

@nvlsianpu
Copy link
Contributor Author

cc @pan- @anangl

@@ -0,0 +1,55 @@
# Nordic platform's readme
Copy link
Contributor

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 ?

Copy link
Contributor Author

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 nvlsianpu changed the base branch from master to feature-nrf5_dfu_s13x_v2 December 22, 2016 15:08
@sg-
Copy link
Contributor

sg- commented Jan 9, 2017

@nvlsianpu @pan- any updates or things left to do here?

@nvlsianpu
Copy link
Contributor Author

I rebased this.


Nordic provides several development kit targets, called *[base target]*. For example:
- NRF51_DK
- NRF51_DK_LEGACY
Copy link
Member

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 ?

Copy link
Contributor Author

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!
Copy link
Member

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.

Copy link
Contributor Author

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:
Copy link
Member

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.

Copy link
Contributor Author

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!

Copy link
Member

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 ?

Copy link
Contributor Author

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:
...

@adbridge
Copy link
Contributor

@pan- can you please review update?

@pan-
Copy link
Member

pan- commented Jan 12, 2017

@adbridge @sg- I think this PR is ready to go.

@bridadan
Copy link
Contributor

Great, thanks @pan-!

@adbridge adbridge merged commit 33bf0a8 into ARMmbed:feature-nrf5_dfu_s13x_v2 Jan 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants