Create root README.md

thetribeio · Aug 16, 2023 · 9698375 · 9698375
1 parent ae09e6c
commit 9698375
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/generators/root/templates/base/README.md 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