This is the catchphrase: what does this project do and how is it unique? Here is an additional quick introduction, if necessary.
Why does this project exist? Come on, don't delete this part. Fill it. Yes it's hard, but it's perhaps the most important part of the README.
As to why this project exist, it's to serve as a template for future open source PHP projects. Of course, feel free to fork it and make your own recipe.
Describe how to install the project/library/framework/…
Make sure your installation instructions work by testing them!
Describe how to use the project. A gif or a short code example is the best way to show how it works. Also keep paragraphs short and sentences simple: not everybody speaks english well.
For the sake of the example here is how you can use this project template as a basis for your own repository:
git clone https://github.com/vanoix/repository-template.git my-project
cd my-project
# Remove the git repository metadata
rm -rf .git/
# Start a brand new repository
git init
git add .Easy peasy! Now you just have to code.
Make sure your examples work by testing them! I didn't test mine and I should feel ashamed.
See the CODE OF CONDUCT file. (Don't forget to change default email)
See the CONTRIBUTING file.
Come on, choose a license already! If you don't know or don't care, the MIT license is the most widely used license.
For this project, I choose […drumroll…] the Do What the Fuck You Want to Public License.
See the SUPPORT file. (Don't forget to change default email/slack/...)
You should review templates for issue/(pull|merge) requests for github and gitlab. Feel free to update them and, if you work with gitlab, add others templates.
- README, CONTRIBUTING and LICENSE are heavily inspired by project-template
- Issue and PullRequest templates comes from Open-Source Templates