From b4a6ebc1377c387675136fe29bcfac4c5fa3fa45 Mon Sep 17 00:00:00 2001
From: Alexander Mazuruk <a.mazuruk@samsung.com>
Date: Fri, 21 Sep 2018 13:42:27 +0200
Subject: [PATCH] Adjust README

* Add info regarding docker build
* Remove tizen.org related stuff in favor of github.com
* Add reminder about setting boruta flag
* Fix rst error - lack of newline after a list
* Unify lists to use *

Change-Id: I3fd43674fc8e482fa1e2e8015c070c056bcbe32a
Signed-off-by: Alexander Mazuruk <a.mazuruk@samsung.com>
---
 README | 100 ++++++++++++++++++++++++++++++++---------------------------------
 1 file changed, 49 insertions(+), 51 deletions(-)

diff --git a/README b/README
index a6ef4c6..23cde2a 100644
--- a/README
+++ b/README
@@ -12,10 +12,10 @@ Weles was inspired by LAVA_.
 
 Weles responsibilities include:
 
-- acquiring DUT from Boruta_ system
-- flashing images to the DUT
-- running tests
-- presenting results in a human and computer-readable form
+* acquiring DUT from Boruta_ system
+* flashing images to the DUT
+* running tests
+* presenting results in a human and computer-readable form
 
 .. [#] Device Under Test
 .. _MuxPi: https://git.tizen.org/cgit/tools/muxpi
@@ -25,16 +25,16 @@ Weles responsibilities include:
 
 User provides a yaml file containing all neccessary information to perform tests:
 
-- required capabilities of a target device
-- timeouts
-- priority
-- interface for accessing target
-- credentials, input sequences
-- test cases to be run defined as a list of:
+* required capabilities of a target device
+* timeouts
+* priority
+* interface for accessing target
+* credentials, input sequences
+* test cases to be run defined as a list of:
 
-  - commands for target
-  - files to be pushed to target
-  - artifacts to be collected from a target
+  * commands for target
+  * files to be pushed to target
+  * artifacts to be collected from a target
 
 Check sample yaml for Weles in parser/sample_yaml
 
@@ -43,72 +43,68 @@ Check sample yaml for Weles in parser/sample_yaml
 Deployment
 **********
 
-
-Local
-=====
+Docker
+======
 
 Prerequisites
--------------
-- git
-- make
-- `go (1.10+)`_
 
-.. _`go (1.10+)`: https://golang.org/doc/install
+* Docker_
+* Make_
 
-Getting sources
----------------
+.. _Docker: https://www.docker.com/
+.. _Make: https://www.gnu.org/software/make/
 
-Repository is currently on tizen.org which does not support ``go get``.
-Move to github.com is planned. Currently, some things need to be done manually.
 
-Create directory for Weles and Boruta:
+Clone Weles and go to that directory::
 
-  $ mkdir -p $GOPATH/src/git.tizen.org/tools
+  $ git clone https://github.com/SamsungSLAV/weles.git && cd weles
 
-Go to that directory:
+Adjust swagger.yml to your instance. You should only edit following fields:
 
-  $ cd $GOPATH/src/git.tizen.org/tools
+* description
+* termsOfService
+* contact
+* host
 
-Download Weles:
+And build Weles::
 
-  $ git clone git://git.tizen.org/tools/weles -b master
+  $ make docker-build
+
+Local
+=====
 
-And its dependencies:
+- git
+- make
+- `go (1.10+)`_
 
-Boruta:
+.. _`go (1.10+)`: https://golang.org/doc/install
 
-  $ git clone git://git.tizen.org/tools/boruta -b master
 
-Dep which is used to manage Weles dependencies:
+Go get it and go to weles directory::
 
-  $ go get -u github.com/golang/dep/cmd/dep
+  $ go get github.com/SamsungSLAV/weles
+  $ cd $GOPATH/src/github.com/SamsungSLAV/weles
 
-Go to Weles directory:
+Weles uses Dep to manage dependencies; if you dont have it, go get it::
 
-  $ cd weles
+  $ go get -u github.com/golang/dep/cmd/dep
 
 Download all dependencies:
 
   $ make vendor
 
-Adjust swagger.yml to your instance
------------------------------------
+Adjust swagger.yml to your instance. You should only edit following fields:
 
-Modify following parts of swagger.yml::
+* description
+* termsOfService
+* contact
+* host
 
-  info:
-    description: >-
-      Place your description here.
-    termsOfService: link your ToS
-    contact:
-      email: your@e-mail.com
-  host: host:port
-
-Regenerate server code with your changes in the swagger.yml file:
+Regenerate server code with your changes in the swagger.yml file::
 
   $ make swagger-server-generate
 
-And finally we can build Weles!
+And finally we can build Weles::
 
   $ make server
 
@@ -131,7 +127,9 @@ Following flags may be ignored:
 - --tls*
 - --scheme
 - --socket-path
+
 When you run your server, you can check the API documentation on http://host:port/api/v1/docs/
+Remember to set `--boruta-address` flag with proper Boruta address or Weles won't work!
 
 
 Contact information
-- 
2.7.4