Browse Source

enhance README with a 'Getting Started' section

Manfred Kroehnert 11 years ago
parent
commit
ac8088c376
1 changed files with 18 additions and 1 deletions
  1. 18 1
      README.md

+ 18 - 1
README.md

@@ -1,4 +1,21 @@
 amber-examples
 ==============
 
-Various amber examples
+Various amber examples
+
+Getting started
+===============
+
+To get started you must first initialize the Git submodules these projects depend on:
+
+git submodule update --init --recursive
+
+Afterwards execute one of the start scripts:
+
+start.sh
+start.bat
+
+and point your browser to
+
+http://localhost:4000/
+