Add template readme for HW projects (#6)

README.md

@@ -2,7 +2,7 @@
 
 This repository contains a collection of inspirational, unmaintained [Azure Sphere](https://www.microsoft.com/azure-sphere/) software samples and hardware designs ready to be reused.
 
-Please also see the official Azure Sphere Sample and Azure Sphere Hardware Designs for maintained examples:
+For maintained samples and designs, see the official Azure Sphere Samples and Azure Sphere Hardware Designs repos:
 
 - https://github.com/Azure/azure-sphere-samples
 - https://github.com/Azure/azure-sphere-hardware-designs

Templates/hardware-readme-template.md

@@ -0,0 +1,79 @@
+<!--- This template should be used if the project contains hardware designs. If the project contains both hardware and software designs, please also refer to software-readme-template.md and incorporate relevant sections. -->
+
+<!--- Optional Metadata goes here
+Include the metadata if you want your project to be discoverable by the Microsoft samples browser. See samples-metadata-guide.md for details. --->
+
+# Name of hardware design
+
+<!---Start with a short description of what the project does--no more than two paragraphs
+--->
+
+
+## Contents
+
+<!---List file contents of the project, in table.--->
+
+| 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
+
+<!--- Describe the tool versions used to create this hardware design --->
+
+## 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
+
+<!---Next steps for users to learn more about the technology, how to revise the project to do other interesting things, etc. Don't reiterate the online documentation here; link to it if necessary. --->
+
+## 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
+
+<!---If you will reply to issues, please suggest how users should report problems or reach out. Github issues is preferable.--->
+
+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
+
+<!--- Include the following text verbatim--->
+
+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](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## License
+
+<!---Make sure you've added the [Creative Commons Attribution 4.0 International Public License](https://github.com/Azure/azure-sphere-hardware-designs/blob/master/LICENSE) to the folder.--->
+<!---If you have software as well as hardware in this folder, then also add [MIT license](https://docs.opensource.microsoft.com/content/releasing/license.html) to this folder as LICENSE-CODE and change the below statement to "Code in this folder is licensed under the MIT license (see LICENSE-CODE).  Any other content is licensed under the Creative Commons Attribution 4.0 International Public License (see LICENSE) -->
+
+For details on license, see LICENSE in this directory.

Templates/software-readme-template.md

@@ -16,7 +16,7 @@ Include the metadata if you want your project to be discoverable by the Microsof
 | `src`       | source code. |
 | `CHANGELOG.md` | List of changes to the project. |
 | `README.md` | This README file. |
-| `LICENSE`   | The license for the project. |
+| `LICENSE.txt`   | The license for the project. |
 
 ## Prerequisites
 
@@ -92,6 +92,6 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any addi
 
 ## License
 
-<!---Make sure you've added the [MIT license](https://docs.opensource.microsoft.com/content/releasing/license.html) to the repository.--->
+<!---Make sure you've added the [MIT license](https://docs.opensource.microsoft.com/content/releasing/license.html) to the project folder.--->
 
 For details on license, see LICENSE.txt in this directory.