JohnENoonan/README-Template

A template README for projects :octocat:

Project Title

A template for README files that can be used for your future projects. A small description about the project, shields as well as the link to your repo.

Open and view the Project using the .zip file provided or at my GitHub Repository

The project is also hosted on GitHub Pages

Table of Contents

• Getting Started
  • Tools Required
  • Installation
• Development
  • Part 1: Heading
    • Step 1: Subheading
    • Step 2: Subheading
  • Part 2: Heading
• Running the App
• Deployment
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Getting Started

The project might have multiple branches: master, development, etc. which can be explained here

• master contains aggregate code of all branches
• development contains code under development

Other details that need to be given while starting out with the project can be provided in this section. A project structure like below can also be included for the big projects:

	project-title
	├── README.md
	├── package.json
	├── .gitignore
	├── public
	│   ├── favicon.ico
	│   ├── index.html
	│   └── manifest.json
	└── src
		├── App.css
		├── App.js
		├── App.test.js
		├── index.css
		├── index.js
		├── logo.svg
		└── serviceWorker.js
		└── setupTests.js

Tools Required

All tools required go here. You would require the following tools to develop and run the project:

• A text editor or an IDE (like IntelliJ)
• Mention the other tools required for the project

Installation

All installation steps go here.

• Installing a particular tool

  • Steps to complete it

• Installing another tool

Development

This section is completely optional. For big projects, the developement strategies are not discussed. But for small projects, you can give some insight to people. It has 2 benefits in my opinion:

1. It's a way to give back to the community. People get to learn from you and appreciate your work
2. You can refer the README in future as a quick refresher before an interview or for an old project to check if it can help you in your currect work

Part 1: Heading

Step 1: Subheading

• Mention the steps here
  • You can also have nested steps to break a step into small tasks

Step 2: Subheading

• Mention the steps here.
  • You can also have nested steps to break a step into small tasks

For details now how everything has been implemented, refer the source code

Part 2: Heading

• Mention the steps here

Running the App

Steps and commands for running the app are to be included here

• Example steps:

    Example command
  

Deployment

This section is completely optional. Add additional notes about how to deploy this on a live system

Contributing

Mention what you expect from the people who want to contribute

We'd love to have your helping hand on Project Title! See CONTRIBUTING.md for more information on what we're looking for and how to get started.

Versioning

If your project has multiple versions, include information about it here.

For the available versions, see the tags on this repository

Authors

Madhur Taneja

• GitHub
• LinkedIn

You can also see the complete list of contributors who participated in this project.

License

Project Title is open source software licensed as MIT.

Acknowledgments

This section can also be called as Resources or References

• Code Honor if someone's work was referred to
• Tutorials followed
• Articles that helped
• Inspiration
• etc