Skip to content

Instantly share code, notes, and snippets.

@iranreyes
Forked from PurpleBooth/README-Template.md
Last active May 2, 2017 20:53
Show Gist options
  • Save iranreyes/614820dddbd0b836d1f00888c0c68b25 to your computer and use it in GitHub Desktop.
Save iranreyes/614820dddbd0b836d1f00888c0c68b25 to your computer and use it in GitHub Desktop.
A template to make good README.md

Project Title

[Continue Integration Badge]

One Paragraph of project description goes here

Technical Information

Overview of the technologies used in the project.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them (Backend & Frontend)

Give examples

Installing

A step by step series of examples that tell you have to get a development env running. (Frontend & Backend)

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the project

Steps to run the project. (Frontend & Backend)

Running the tests

Explain how to run the automated tests for this system.

Environments

List of the URLs

Note: In order to get access to those environment please reach the Lead Developer, Producer or Technical Director.

Accounts

To be full engage to this project you will need access below accounts, please feel free to ask for them to the Lead Developer, Producer or Technical Director

  • Google Analytic
  • Jam3 Dev Server(Access with SSH)
  • Wordpress CMS Dev Administration
  • Wordpress CMS Stage Administration
  • Wordpress CMS Production Administration

Deployment

Add additional notes about how to deploy this on a live system

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Bullet list with Name - Role - Github account - Email.

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment