Skip to content

Instantly share code, notes, and snippets.

@euikook

euikook/README.md

Forked from PurpleBooth/README-Template.md
Last active February 18, 2021 04:24
Show Gist options
  • Save euikook/ab6add0169bc97cbdc1c3cf26358c388 to your computer and use it in GitHub Desktop.
Save euikook/ab6add0169bc97cbdc1c3cf26358c388 to your computer and use it in GitHub Desktop.
Download ZIP
A template to make good README.md
Raw
README.md

Foo Bar

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. 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

Give examples

Build and Installing

docker-compose build

Running the tests

docker-compose up

Break down into end to end tests

N/A

And coding style tests

Deployment

docker-compose up

Built With

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

  • E.K. KIM - Initial work - euikook

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

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