Skip to content

Instantly share code, notes, and snippets.

@bahreex

bahreex/Sample-Readme.md

Last active May 7, 2020 12:16
Show Gist options
  • Save bahreex/f7c8e52d33784fe1af4a1f61bbae70ae to your computer and use it in GitHub Desktop.
Save bahreex/f7c8e52d33784fe1af4a1f61bbae70ae to your computer and use it in GitHub Desktop.
Download ZIP
This is a Sample "Readme.md" file for guidance on building the same.
Raw
Sample-Readme.md

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

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 tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

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

Built With

Contributing

Versioning

We use SemVer for versioning.

Authors

License

This project is licensed under the MIT License

Acknowledgments

  • a
  • b
  • c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment