diff --git a/generators/root/templates/base/README.md b/generators/root/templates/base/README.md new file mode 100644 index 000000000..299c39633 --- /dev/null +++ b/generators/root/templates/base/README.md @@ -0,0 +1,27 @@ +# README + +## Prerequisites + +Docker and docker-compose must be installed and running. + +## Install + +Simply run the following script to initiate bootstrapping + +``` +./script/bootstrap +``` + +## Run + +Launch your containers by using : + +``` +./script/server +``` + +The project is available on localhost:80 + +## Provision a new environment + +Check under `/environments` folder for Terraform information about provisionning