Skip to content

[AE-158] Make readme more user-friendly #18

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

Merged
merged 4 commits into from
Sep 7, 2023

Conversation

aliphys
Copy link
Contributor

@aliphys aliphys commented Sep 7, 2023

To make the readme more applicable to users:

  • 🔬 Reworded compatibility to say that it has been tested on the following STM32 and Renesas based Arduino boards. By reducing the scope to what has been tested, we can make users feel more confident. We can always increase the supported boards to include (for example) the Nicla Sense later.
    ## Compatibility
    This library has been tested with the following STM32 and Renesas based Arduino boards. The availability of storage mediums depends on the hardware interfaces:
  • ➕ Added Opta to the list of compatible boards. The complie-sketches workflow does indeed compile for it, and we have tested on the physical Opta as well
    * Opta: Internal QSPI Flash and USB
  • 🔠 Shortened the descriptions for the examples in the read me. There is an extended description inside the .ino sketches for people who want more details.
    ## Examples
    * [**examples/SimpleStorageWriteRead**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/SimpleStorageWriteRead/SimpleStorageWriteRead.ino) - Write/read simple data from SD, USB and internal storage
    * [**examples/AdvancedUSBInternalOperations**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/AdvancedUSBInternalOperations/AdvancedUSBInternalOperations.ino) - Navigate file structure and demonstrate file operations between USB and internal storage
    * [**examples/PortentaH7Logger**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/PortentaH7Logger/PortentaH7Logger.ino) - Log analog input to the Portenta H7 with timestamp, then save to internal storage and backup to USB (if detected)
    * [**examples/BackupInternalPartitions**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/BackupInternalPartitions/BackupInternalPartitions.ino) - Back up all partitions on the internal storage to a USB Mass Storage device.

    @cristidragomir97 can you confirm the compatibility list is accurate?

@aliphys aliphys added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Sep 7, 2023
@aliphys aliphys self-assigned this Sep 7, 2023
@aliphys
Copy link
Contributor Author

aliphys commented Sep 7, 2023

@per1234 Do we know why the compile-sketches workflow is stuck in the Expected status?
image

@sebromero
Copy link
Contributor

@aliphys because this change does not change any file that would trigger that action. It won't run.

@sebromero sebromero merged commit bfcb677 into main Sep 7, 2023
@sebromero sebromero deleted the aliphys/compatibilityRevise branch September 7, 2023 11:29
@sebromero
Copy link
Contributor

@per1234 I guess the question is, if that action should run for any change to any file (remove the file patterns in the workflow file), or if we should remove that branch protection rule. I think I'd go with the first option.

@per1234
Copy link
Contributor

per1234 commented Sep 7, 2023

I'd go with the first option

That is a reasonable choice. The purpose of the paths filter is to avoid unnecessary runs of the workflow for changes that are not relevant to the compilation of sketches. But the occasional unnecessary workflow run doesn't do any significant harm. Public repositories have unlimited free GitHub Actions minutes.

It is really unfortunate that GitHub's implementation of required status checks isn't more intelligent. The system should be smart enough to understand that it should not impose the requirement when the workflow run wasn't triggered

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants