Write a little description about your project. 2-3 sentances are enough.
Tools and packages required to successfully install this project. For example:
A step by step list of commands / guide that informs how to install an instance of this project.
$ pip install foobar
$ npm install project-name --save
$ any other command
For Linux and OS X
npm install project-name --save
For Windows
git clone project-url
Use this space to give a little demo of your project. Attach important screenshots if applicable. This section is optional and might not be applicable in some cases.
Write a little about unique features of your project and what makes it outstanding. Describe the functionalities of your project. You can make a list of it with some descriptions, like:
- Used Bootstrap to make it 100% responsive
- Used AI/ML to automate some stuff
- Etc Etc......
Show how and what your project does. Users should figure out how your project solves their problem by looking at the code example. Spice this up with code blocks and potentially more screenshots. These examples should motivate the users to use your project.
import foobar
foobar.pluralize('word') # returns 'words'
foobar.pluralize('goose') # returns 'geese'
foobar.singularize('phenomena') # returns 'phenomenon'Mention any other documentation or live example available for reverence.
Describe and show how to run the tests with code examples.. Explain how to run the automated tests for this system. Also explain how to test and why to test.
Give code examples as:
test example 1test example 2npm testtest till you finish
Explain how to deploy your project on a live server. To do so include step by step guide. Potentially do this for multiple platforms.
virtualenv foobar
npm test
make install
pip install -e .
More examples please....List down the technology / frameworks / tools / technology you have used in this project.
- Laravel - The PHP framework
- IPFS - A peer-to-peer hypermedia protocol to make the web faster, safer, and more open.
- Android - The world’s most popular mobile OS
Mention how anyone can contribute to make this project more productive or fix bugs in it.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
Steps to contribute:
- Fork this repository (link to your repository)
- Create your feature branch (git checkout -b feature/fooBar)
- Commit your changes (git commit -am 'Add some fooBar')
- Push to the branch (git push origin feature/fooBar)
- Create a new Pull Request
Additionally you can create another document called CONTRIBUTING.md which gives instructions about how to contribute.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Write about yourself or your organization, who created this project. For example:
Sagar Ganiga – [email protected]
You can find me here at: Github LinkedIn
Give credits to all the useful resources you used to create this project. It could be a link to any repository which inspired you to build this project, any blog or links to people who contributed in this project.
A heartfelt thank you to @UjalaJha for the encouragement I needed to get this idea off the ground and start writing!
Thank you to the following awesome geeks for sending PRs and improving the Quality of this project ❤️
Here's a list of other related projects / blogs which helped me in creating the best possible version of my project:
- README-Template.md by @PurpleBooth
- A Beginners Guide to writing a Kickass README ✍ by Akash Nimare
- readme-best-practices by @jehna
- readme-template by @dbader
- art-of-readme by @noffle
- Make a README
A short snippet describing the license (MIT, Apache etc).
This project is licensed under the MIT License - see the LICENSE.md file for details
MIT © Yourname