Readme update

[ddB0515]

Hi

I'm planing to prepare board based on nRF52840 and make PR to be available with Community_nRF52_Arduino but Readme is lacking information in general but most how to add new boards, suggestions, etc...

Recently I have requested PID for firmware/bootloader so can be used with Adafruit Bootloader and submitted as you are for openmoko openmoko/openmoko-usb-oui#29

as you have done same for openmoko/openmoko-usb-oui#20
and as you can check there are some missing information for Licensing also

So if you can check and add description that 3rd party libraries using different licenses

Here is list that I have managed to get (if I missed some add it to the list please)

Licenses

• Communitiy nRF52 - Lesser General Public License v2.1
• Adafruit_LittleFS - BSD 3-Clause
• BlueFruit - MIT License
• Adafruit_TinyUSB_Arduino - MIT License
• BLEAdafruitService - MIT License
• BLEHomeKit - BSD License
• BlueFruit52 - MIT License
• InternalFileSytem - MIT License
• PDM - Lesser General Public License v2.1
• RotaryEncoder - MIT License
• SPI - Lesser General Public License v2.1
• Servo - Lesser General Public License v2.1
• SoftwareSerial - Lesser General Public License v2.1
• Wire - Lesser General Public License v2.1

[jpconstantineau]

You will likely need to also point to the nrf52 bootloader repo. (This is for the usb PID request)

For the licenses, we can add a section summarizing the licenses but we should indicate that the table is for reference and that each library is it's own project and that the license information included with each library would be the one in place if there are any discrepancies between the library and the table.

I agree that the process of adding new boards isn't described.

Have a look at the two new boards that got added recently. These will highlight the new files and additions. If you do add a section in the readme, I can help you out sorting out the details.

The process is very similar for nrf52832 and nrf52840 boards; the main difference between the two being the USB PID information that's needed. Everything else is pretty much the same. Replace "your_variant" with an appropriate name in the instructions below:

1 - create your board variant.cpp and variant.h files and put them in a new folder named for your_variant.
2 - create your_variant folder in the bootloader folder and add the bootloader files. zip and hex files are needed.
3 - Edit the boards.txt. Copy an example that's "similar" to your board.
4 - Note that your_variant should be used as the main key and that the your_variant.build.variant key should be equal to your_variant.
5 - nrf52840 boards will have the vid and pid you have requested from openmoko or other source.
6 - Edit the Readme.md file to add your variant to the list

[ddB0515]

You will likely need to also point to the nrf52 bootloader repo. (This is for the usb PID request)

I did, it's in PR as link to Bootloader

I am surprised at the LGPL for the community nrf52 as it should be the same as the adafruit nrf52 Arduino one as it's essentially a fork of it.

I think all needs to be clear for them so there is no licence violation(as your don't have anything related to that so maybe description would be clear to point in right directions)

I agree that the process of adding new boards isn't described.

Have a look at the two new boards that got added recently. These will highlight the new files and additions. If you do add a section in the readme, I can help you out sorting out the details.

I already did and thanks fgor great work, maybe will write something after make PR for mine so you can add it to Wiki

[jpconstantineau]

If you do a PR, can you do it on the develop branch? there has been quite a few changes since the last push to main. I suspect that I will need to do a large update before I start at looking at merging in the changes the 0.22.x adafruit nrf52 releases have brought in.

[jpconstantineau]

@ddB0515 Can you do a PR with the updated information (Idon't recall seeing one)? I am also planning to add a new board and I would rather add your work instead of copy/pasting it and missing something.

[ddB0515]

Hello @jpconstantineau

Sorry for long time not responding as life happening and too much distraction
I'll create PR soon as I just submitted PR for Adafruit Bootloader
adafruit/Adafruit_nRF52_Bootloader#258

Also have stashed changes for board locally so need to make checks before I do it but expect soon
Maybe if I manage this year if not next one ;)

[jpconstantineau]

Wow. It's been a while indeed. You can do a PR for your changes and I'll bring them in. You might do a PR in 2 places as I am thinking of having a proper fork of the Adafruit nrf52 BSP you can find it here:

…

On Wed, Dec 29, 2021 at 5:03 PM Dario Budimir ***@***.***> wrote: Hello @jpconstantineau <https://github.com/jpconstantineau> Sorry for long time not responding as life happening and too much distraction I'll create PR soon as I just submitted PR for Adafruit Bootloader adafruit/Adafruit_nRF52_Bootloader#258 <adafruit/Adafruit_nRF52_Bootloader#258> Also have stashed changes for board locally so need to make checks before I do it but expect soon Maybe if I manage this year if not next one ;) — Reply to this email directly, view it on GitHub <#19 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIYW6H5ZWOJWUYONKAB2KLUTOHU7ANCNFSM46MRETDQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Pierre

[jpconstantineau]

Wow. It's been a while indeed. You can do a PR for your changes and I'll bring them in. You might do a PR in 2 places as I am thinking of having a proper fork of the Adafruit nrf52 BSP you can find it here: https://github.com/nRF52-Arduino/nRF52_Arduino/tree/main This is in addition to the outdated community nrf52 bsp. It's outdated as it's from prior 0.20 I believe - where they had issues with high power consumption. I am slowly working on my BlueMicro firmware to support the latest BSP from adafruit, once that is done, I'll upgrade the community BSP. Pierre On Wed, Dec 29, 2021 at 5:37 PM Pierre Constantineau < ***@***.***> wrote:

…

Wow. It's been a while indeed. You can do a PR for your changes and I'll bring them in. You might do a PR in 2 places as I am thinking of having a proper fork of the Adafruit nrf52 BSP you can find it here: On Wed, Dec 29, 2021 at 5:03 PM Dario Budimir ***@***.***> wrote: > Hello @jpconstantineau <https://github.com/jpconstantineau> > > Sorry for long time not responding as life happening and too much > distraction > I'll create PR soon as I just submitted PR for Adafruit Bootloader > adafruit/Adafruit_nRF52_Bootloader#258 > <adafruit/Adafruit_nRF52_Bootloader#258> > > Also have stashed changes for board locally so need to make checks before > I do it but expect soon > Maybe if I manage this year if not next one ;) > > — > Reply to this email directly, view it on GitHub > <#19 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAIYW6H5ZWOJWUYONKAB2KLUTOHU7ANCNFSM46MRETDQ> > . > Triage notifications on the go with GitHub Mobile for iOS > <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> > or Android > <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. > > You are receiving this because you were mentioned.Message ID: > ***@***.***> > -- Pierre

-- Pierre