Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.51 KB

hardware-readme-template.md

File metadata and controls

74 lines (48 loc) · 3.51 KB

Name of hardware design

Contents

File/folder Description
Schematic.pdf Schematic
BOM.xlsx Bill of materials
PCB.pdf Report on PCB stack-up
Altium Altium Designer schematics, PCB layout, and supporting project files
CHANGELOG.md List of changes to the project.
README.md This README file.
LICENSE The license for the project.

Tools

Key concepts

Discuss the aspects of the project that might be particularly useful to someone looking at it:

  • Significant design decisions
  • Gotchas and tricky bits
  • Opportunities for customization

Next steps

Project expectations

Describe the state of the design. For example:

  • The design has been manufactured and tested / not been manufactured
  • Certifications or standards that the design has been tested for / not been tested for (if relevant)

Expected support for the project

How often will you check and reply to issues or maintain and update the code? For example:

  • Will reply to issues once per quarter, once a year, etc.
  • No support whatsoever, code is as is

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

License

For details on license, see LICENSE in this directory.