README: getting started quick guide

[irc/UndernetIRC/undernet-development-env.git] / README.md

diff --git a/README.md b/README.md
index 74bf668b02bff3a3413ac13d3c03f58c0d371a77..3c26f5fcda07492aa3eb40e8057d909bd66737ac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,6 +18,19 @@ It includes the following services:
 - docker
 - docker-compose
 
+# Getting started
+
+This project uses git submodules. After cloning this repository the submodules needs to be
+initialized and updated. Follow this step-by-step guide to get your new UnderNET environment 
+up and running.
+
+```
+git clone https://github.com/Ratler/undernet-development-env.git
+cd undernet-development.env
+git submodule init
+git submodule update
+docker-compose up
+```
 
 # FAQ
 Q: Why do I see this message _"X (cservice@undernet.org): AUTHENTICATION FAILED as <user>