From 0d2f71220d7a220c20d91475faead2420423c3cc Mon Sep 17 00:00:00 2001 From: spzala Date: Thu, 1 Oct 2015 09:24:06 -0700 Subject: [PATCH] Update README The overivew section explains the project well. The one liner causes to create duplicate looking doc when create PyPi package and it doesn't really add much value in README. Also, make all same level heading look same. Change-Id: I01af82cd0abf8e0d23f6c0a338880d1abe464413 --- README.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 92665da8..b72ed14c 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,6 @@ Heat-Translator =============== -Tool to translate non-heat templates to Heat Orchestration Template (HOT). - Overview -------- @@ -25,11 +23,11 @@ Heat-Translator project is mainly built of two components: 2. **Generator** - takes an in-memory graph from **Parser**, maps it to Heat resources and software configuration and then produces a HOT. How To Use -********** +---------- Please refer to `doc/source/usage.rst `_ Directory Structure -******************* +------------------- Three main directories related to the heat-translator are: