[TIC-CORE] Logger support and add test-cast for repodata
[archive/20170607/tools/tic-core.git] / README.md
index 0931f0e..5405d56 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,34 @@
 TIC-CORE
 ================
 
-TIC means "Tizen the Image Creator" and it's used to create images for Tizen.
+TIC means "Tizen the Image Creator" and it's used to generate the recipes or create images for Tizen.
 The tool offers major functions:
 
-- install dependency analysis 
+- install-dependency analysis 
 - recipe creation
 - file conversion between recipe to kickstart using kickstarter
 - image creation using mic
 
+
+Prerequisites
+-------------
+
+- Install lxml (http://lxml.de/index.html)
+- Install Flask (http://flask.pocoo.org/)
+
+
 Installation
 ------------
 
-Install lxml (http://lxml.de/index.html)
-
-run make
+git clone ssh://{USER_ID}@review.tizen.org:29418/tools/tic-core
 sudo python setup.py install
 
+
 Usage
 -----
 
-packageanalyzer <option>
+usage: tic-core {analysis,start}
 
 Example:
-       packageanalyzer <option>
+       tic-core analysis --repo "https://download.tizen.org/snapshots/tizen/base/latest/repos/arm64/packages"
+       tic-core start --port 59001