Welcome! This repository contains a collection of README templates. I created this repository as a way to share my work with others and to improve README files on github!
Feel free to browse through the contents of the repository and use anything that you find useful. If you have any suggestions or improvements, please don't hesitate to Contribute. I'm always open to feedback and new ideas.
Thank you for visiting!
To help us improve this repository, please help us translate the readme pages. Your work will be very much appreciated!
- Choose a README file to translate in the EN/*/* directory
- Follow steps 1 trough 4 at How To Contribute
- Add or find the folder with your language
- Add or find the folder where your translated readme is located
- Add your README file with the following name: {original english name}_{your language code}.md
- In that file, you must use this template:
<!--Title start
Title end-->
<!--Start template-->
<!--YOUR translated template goes here-->
<!--End template-->
- Translate the original english text to your language, and put it inbetween the template comments!
- Follow steps 5 trough 7 at How To Contribute
This README file is not a template! However, it is mostly made out of templates that are included in this repository!
To contribute to this repository, follow these steps:
-
Fork the repository: First, you will need to create a fork of the repository that you want to contribute to. A fork is a copy of the repository that you can use to make changes without affecting the original repository. To create a fork, click the "Fork" button on the repository page on GitHub.
-
Clone the repository: Next, you will need to clone the repository to your local machine. This will allow you to make changes and commit them to your local repository. To clone the repository, use the
git clonecommand and specify the URL of your fork. For example:git clone https://github.com/TetieWasTaken/README-Templates.git -
Create a new branch: It's a good practice to create a new branch for your changes. This will allow you to keep your changes separate from the main codebase and make it easier to review and merge your changes later. To create a new branch, use the
git branchcommand and specify a name for the branch. For example:git branch my-changes -
Switch to the new branch: To work on the new branch, you will need to switch to it using the
git checkoutcommand. For example:git checkout my-changes -
Make and commit your changes: Now you can make changes to the code on your local machine and commit them to your local repository. Use the
git addandgit commitcommands to stage and commit your changes. Be sure to include a detailed commit message that explains the changes you made. -
Push your changes to your fork: When you are ready to share your changes, you can push them to your fork on GitHub. Use the
git pushcommand and specify the name of your branch. For example:git push origin my-changes -
Create a pull request: Finally, you can create a pull request to request that your changes be merged into the original repository. A pull request is a request to merge the changes in your repository into the original repository. To create a pull request, go to the repository page on GitHub and click the "Compare & pull request" button. Follow the prompts to create and submit the pull request.
We will review your pull request and decide whether to merge the changes into the main codebase.
Thank you for considering contributing to this repository! We welcome contributions from the community and are grateful for any help you can provide.
Before making any contributions, please read the following guidelines to ensure that your contribution is consistent with the overall goals and direction of the project.
This project includes a Code Of Conduct! Not following this might get you in trouble.
This project uses the MIT license.
The MIT License is a permissive open source license that allows users to use, modify, and distribute software freely, as long as they include a copy of the license and its copyright notice. It does not place any restrictions on how the software can be used, including for commercial purposes. However, it does require that users agree not to hold the original authors liable for any damages that may result from using the software. Overall, the MIT License allows users to have a lot of flexibility in how they use and distribute the software, while also providing some basic protections for the original authors.
MIT License
Copyright (c) 2022 Toast
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
To use any template, you can follow these steps;
- Choose a template that you would like to use by navigating through the contents header below.
- Copy the contents of the template file by selecting all of the text and using the
Ctrl + Cshortcut (orCommand + Con a Mac). - Open the file in which you would like to use the template, and place your cursor at the location where you want the template to be inserted.
- Use the
Ctrl + Vshortcut (orCommand + Von a Mac) to paste the contents of the template into your markdown file. - Edit the template to fit your needs by replacing placeholders (such as
{package}or{username}) with the appropriate values. - Save the file to apply the changes.
