search

microsoft / uf2

UF2 file format specification
Other
849 stars 164 forks source link

Extract family data to JSON file #47

Closed bcr closed 3 years ago

bcr commented 3 years ago

This patch creates a new JSON file to address my concern in #46 regarding having a single "source of truth" for family info.

To start with, I extracted the known IDs, short names and descriptions from README.md and uf2conv.py using an included Python script makeuf2families.py. If we choose to continue down this path, this script will no longer be needed and can be removed.

I have updated the uf2conv.py script to use the JSON data.

Long term, when adding new IDs, updating the JSON file directly should be the preferred method. When it is updated, the README can be regenerated using the included updatereadme.py script.

One remaining work item is that the !!! entries in the JSON file need to be resolved, and then the README.md can be updated.

ghost commented 3 years ago

CLA assistant check
All CLA requirements met.

mmoskal commented 3 years ago

Let's stick to JSON as the source of truth and remove the makeuf2families script.

Could you replace the !!! with the short name of MCU (FX2, ESP32, KL32L2) without any xx at the end?

Let's also remove the family IDs from the readme (and remove the script) and instead just link the JSON document from the readme. I don't think there's much value to the users of keeping that list (unlike list of actual bootloader implementations).

bcr commented 3 years ago

Roger that. Changes applied.

bcr commented 3 years ago

Collaborating is caring. I appreciate the consideration.