This repository serves as a general-purpose template for generating new projects.
- Click on the green "Use this template" button at the top right of this page.
- Click on "Create a new repository".
- Fill in the repository name in the form that you see.
- Fill in the description in the form that you see.
- Select which visibility the project should have.
- Click on "Create repository".
- Fill in any extra information that you may need.
- Clone your new repository using
git clone.
- Download the files of this repository, either via a zip archive, or using
git clone. - If you used
git clone, delete the.gitfolder. - If you are using version control (recommended), create the first revision after following the checklist.
The following serves as a checklist - a list of tasks to complete when creating a new project using this template.
- Update the repository name in README_TEMPLATE.md.
- Update the repository description in README_TEMPLATE.md.
- Update the link(s) of the badge(s) at the top of README_TEMPLATE.md.
- Fill in the information under the license heading in README_TEMPLATE.md.
- Fill in the contact details in the code of conduct file.
- Clear the changelog file.
- Clear the features file.
- Clear the issues file.
- Clear the ideas file.
- Update the information in the citation file.
- If you are using a different system to track features, ideas, and/or issues, delete those files respectively.
- Delete this file and rename README_TEMPLATE.md to
README.md. - Commit your changes to version control if applicable.
See FEATURES.md for a list of features of this template.
See CHANGELOG.md for a list of changes throughout different versions.
See IDEAS.md for ideas and planned features for this template.
See ISSUES.md for a list of known bugs/issues with this template.
See CITATION.cff for instructions on how to cite this template.
See CODE_OF_CONDUCT.md for the code of conduct.
Template Repository Copyright (C) 2024-2025 Esoteric Enderman
This template is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This template is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this template. If not, see <gnu.org/licenses>.
template templates template-project template-repository template-generic-repo