Skip to content

Repo - productization "item list" #2

Description

@gigapod

General list of items needed before the repo is published:

  • Add readme file - see this repo for an example - note this example is much longer that is normally expected for our sensors!
    • Include sheilds/badges in the readme (see example)
  • Add license file (MIT) - see this repo](https://github.com/sparkfun/SparkFun_FPC2534_Arduino_Library)
  • Enable doxygen generated documentation and publish to github pages (see the above example, talk with @gigapod ). This will include adding a deployment action/workflow.
  • Setup repo and documentation so it's included on our docs landing page (docs.sparkfun.com) - instructions for this are listed in the readme here
  • Complete setup for publishing the Arduino library (keywords.txt, library.json, library.properites) see this repo for an example
  • Add workflow to perform a cross compile check good example here
  • Right before launch on sparkfun.com, make repo public and publish the library to the Arduino library index. See https://github.com/arduino/library-registry

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions