stephane-klein/README-skeleton

README Skeleton

MyProject

One line project overview.

Table of Contents

• MyProject
  • Goals and objectives
  • Rationalize
  • Quick demo
    • Prerequisites
    • Running demo
  • Go further
  • Contacts

Goals and objectives

Lorem ipsum dolor sit amet, posuere vestibulum tempor lectus sed dictum integer, lobortis ipsum nunc et dui aliquam elementum, justo wisi est ac donec. Porttitor tellus, tincidunt porttitor est aliquet, donec libero suspendisse hendrerit.

Rationalize

• Explain why do you have created this project.
• Explain why use your project instead alternative projects.

Quick demo

Lorem ipsum dolor sit amet, posuere vestibulum tempor lectus sed dictum integer, lobortis ipsum nunc et dui aliquam elementum, justo wisi est ac donec. Porttitor tellus, tincidunt porttitor est aliquet, donec libero suspendisse hendrerit.

Prerequisites

Lorem ipsum dolor sit amet, posuere vestibulum tempor lectus sed dictum integer, lobortis ipsum nunc et dui aliquam elementum, justo wisi est ac donec.

• Docker Engine (version 18.06.1-ce)
• Docker Compose (version 1.22.0)
• Virtualbox (version 5.2.18r124319)
• Vagrant (version 2.1.5)

On macOS you can install prerequisites with Brew:

$ brew cask install docker virtualbox vagrant

Running demo

Lorem ipsum dolor sit amet, posuere vestibulum tempor lectus sed dictum integer, lobortis ipsum nunc et dui aliquam elementum, justo wisi est ac donec. Porttitor tellus, tincidunt porttitor est aliquet, donec libero suspendisse hendrerit.

$ make init
$ make start

Go further

• Continuous Deployment
• How to build MyProject from source
• How to execute tests
• Project directories structure overview

Contacts

How to contact creator: Twitter, email or other...