After repository creation:
- Update this
README.md. Update the Project Name, description, and all sections. Remove this checklist. - Specify your license. This template does NOT ship with a default license. Identify your project's approved license per your organization's license approval guidelines.
- Create
LICENSE.txt. Replace the placeholder text inLICENSE.txtwith the full text of your project's approved license. - Update the License section below to name your approved license and link to it.
- Search this repo for "REPLACE-ME" and update all instances accordingly
- Update
CONTRIBUTING.mdas needed - Review the workflows in
.github/workflows, updating as needed. See https://docs.github.com/en/actions for information on what these files do and how they work. - Review and update the suggested Issue and PR templates as needed in
.github/ISSUE_TEMPLATEand.github/PULL_REQUEST_TEMPLATE - Remove this checklist
<update with your project name and a short description>
Project that does ... implemented in ... runs on Qualcomm® <processor>
main: Primary development branch. Contributors should develop submissions based on this branch, and submit pull requests to this branch.
List requirements to run the project, how to install them, instructions to use docker container, etc...
How to install the software itself.
Describe how to use the project.
How to develop new features/fixes for the software. Maybe different than "usage". Also provide details on how to contribute via a CONTRIBUTING.md file.
How to contact maintainers. E.g. GitHub Issues, GitHub Discussions could be indicated for many cases. However a mail list or list of Maintainer e-mails could be shared for other types of discussions. E.g.
- Report an Issue on GitHub
- Open a Discussion on GitHub
- E-mail us for general questions
<update with your project name and license>
<REPLACE-ME> is licensed under the REPLACE-ME with license name. See LICENSE.txt for the full license text.