[TIC-CORE] support local repository

[archive/20170607/tools/tic-core.git] / README.md

diff --git a/README.md b/README.md
index 0931f0e..d7c101c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,65 @@
 TIC-CORE
 ================
 
-TIC means "Tizen the Image Creator" and it's used to create images for Tizen.
-The tool offers major functions:
+TIC means "Tizen the Image Creator" and it's used to generate the recipes or create images for Tizen.
 
-- install dependency analysis 
-- recipe creation
-- file conversion between recipe to kickstart using kickstarter
-- image creation using mic
+TIC support the following major functions:
+  * install-dependency analysis
+  * recipe creation
+  * file conversion between recipe to kickstart using kickstarter
+  * image creation using mic
+
+Resource
+--------
+  * REPO: https://download.tizen.org/tools/
+  * DOCS: [TODO]
+  * CODE: https://review.tizen.org/gerrit/tools/tic-core
+  * BUGS: https://bugs.tizen.org/jira
+  * HELP: general@lists.tizen.org
+ 
+License
+-------
+[TODO]
 
 Installation
 ------------
 
-Install lxml (http://lxml.de/index.html)
+Install the following python modules before installing tic-core
+ * Install lxml (http://lxml.de/index.html)
+ * Install flask (http://flask.pocoo.org/)
 
-run make
-sudo python setup.py install
+Clones the tic-core source from git
+ * git clone ssh://review.tizen.org:29418/tools/tic-core
+ 
+Install tic-core module
+ * sudo python setup.py install
 
 Usage
 -----
 
-packageanalyzer <option>
+You can use 'tic-core --help' or 'mic <subcmd> --help' to get the help message.
+How to get help:
+* For global options and the command list:
+  * $ tic-core -h | --help
+* For each sub-command:
+  * $ tic-core <sub-command> --help 
+  
+tic-core provides several subcommands, including:
+* tic-core start: 
+  * the tic-core daemon server on system. port 8082 is used default
+  * $ tic-core start --port 8082
+* tic-core analyze:
+  * analyze install-dependency of packages
+  * $ tic-core analyze --repos {repo-url} 
+* tic-core export:
+  * export files (ks/recipes)
+  * $ tic-core export --format ks --recipes {recipes} --outdir /var/tmp
+  * $ tic-core export --format recipe --recipes {recipes} --outdir /var/tmp
+* tic-core createimage:
+  * create an image for tizen
+  * $ tic-core createimage --recipe {recipe} --output /var/tmp
 
-Example:
-       packageanalyzer <option>
+Contacts
+--------
+When you found a bug, you can file this bug in our official bug tracker:
+https://bugs.tizen.org/jira
\ No newline at end of file