add a simple README.md

0f895e78 · Yori 'AGy' Fournier · 1a02c13d · 0f895e78
Commit 0f895e78 authored Mar 22, 2017 by Yori 'AGy' Fournier
Hide whitespace changes
Inline Side-by-side

Showing with 19 additions and 0 deletions

README.md README.md +19 -0

No files found.
--- a/README.md
+++ b/README.md
+# My Design Gui
+
+## Summary
+
+1. [Get started](#get-started)
+
+## Get started
+
+1. Get the source
+
+```
+git clone git@gitlab.aip.de:yfournier/mydesigngui.git mydesigngui
+```
+
+2. Let the show begin!
+
+```
+python -m mydesigngui
+```