This is a template for a open source GitHub repo. It can be used to jump start with creating your new open source project.
Disclaimer This repository is a work in progress as of writing this README.
These instructions will get you a copy of the project up and running on your local machine for setting up your next big open source project. Just update the helpful TODOs & FIXMEs & you should be ready.
Install Git & create an account in GitHub or any git based VCS system you like.
Download the project zip & unzip & jump start your project.
Clone the project and change the origin remote repo to your git repo, following commands might be handy
git clone http://github.com/chiragbhatia94/open-source-template
cd open-source-template
git remote remove origin
git remote add origin <!-- your github repo -->No tests needed here.
Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
Please read out contributing guidelines for details.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Chirag Bhatia - Initial work - chiragbhatia94
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details