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

Add README.md for Catena4450_test01.ino #58

Closed
terrillmoore opened this issue Feb 16, 2019 · 0 comments
Closed

Add README.md for Catena4450_test01.ino #58

terrillmoore opened this issue Feb 16, 2019 · 0 comments
Labels
docs Documentation errors/improvement reqeusts
Projects

Comments

@terrillmoore
Copy link
Member

Every sketch needs a README.md explaining (at a minimum):

  • what the sketch is intended to do, and when to use it
  • which Catenas are supported
  • what external hardware is required, and what external hardware is optionally supported
  • what libraries are needed
    • how to set up libraries using git-boot.sh (if using git-boot.sh)
    • how to set up libraries from the Arduino environment (if using the environment)
  • data format (pointing to extras and the appropriate docs)
  • how to provision (pointing to the general instructions) plus any info about platform GUIDs
  • how to verify that it's working
@terrillmoore terrillmoore added the docs Documentation errors/improvement reqeusts label Feb 16, 2019
@dhineshkumarmcci dhineshkumarmcci added this to Done in v1.3.0 Dec 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation errors/improvement reqeusts
Projects
Development

No branches or pull requests

1 participant