A simple template for writing a project's README.
Author: CormacSharkey
Table of Contents
About: describe the project simply; why it was created, how it works and how it was created (non-technical). Anything else "about" the project can also be included.
In my opinion, a project's README is as important as the project itself, as such it is important to get it right without being overly complicated.
While working on projects, I found myself struggling to create a README that was structured and helpful for a reader trying to understand it. That's why I made this template!
Feel free to use this template for some or all of your projects (or none!), I compiled this from various examples and guides online, and edited it until I was happy.
Getting Started: divided into prerequisites and installation; how to set up the project locally and instructions should be included with no details omitted, in the simplest language.
Prerequisites: a list of things needed to use the project and how to install them.
- NumPy
pip install numpy
- Get a free API Key from Example.com
Installation: a list of steps to install the project locally. Be as simple as possible and include everything.
- Clone the repo
git clone https://github.com/CormacSharkey/README-Template.git
-
Create a
.env -
Add your API Key
API_KEY="XXXXXXXXXXXXXXXX"
- Change the remote git url to avoid pushing to base project
git remote set-url origin github_username/repo_name
git remote -v # confirm the changes
Usage: explain how to use the project, with examples and links to documentation.
Find more examples and explanations in the Documentation
Contributions: detail how others may contribute if the project is open-source, or highlight top contributors.
If you want to contribute something that makes this better, please fork the repo and create a pull request. Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'added some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Acknowledgements: acknowledge anyone or anything you want to credit for work on the project.
Project Resources: