TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
If you got any Questions, please contact the Repo-Owner.
/Name/
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
- Installation process
- Software dependencies
- Latest releases
- API references
TODO: Describe and show how to build your code and run the tests. After a release new contributions are only allowed in new branches. After the Modifications have been checked by a secund Person, a new release will be created.
TODO: Explain how other users and developers can contribute to make your code better.
Example: Every body is welcome to commit to his repo and expand our Altium Components, Templates, etc.
Keep in mind to only commit changes on a new branch, write notes and ask somebody else to review your changes.
If you just noticed a error and / or are unable to correct the mistake, please create an issue in the Github Repo.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files:
- To Do 1
- To Do 2