README.md

   1 TIC-CORE
   2 ================
   3
   4 TIC means "Tizen the Image Creator" and it's used to generate the recipes or create images for Tizen.
   5
   6 TIC support the following major functions:
   7   * install-dependency analysis
   8   * recipe creation
   9   * file conversion between recipe to kickstart using kickstarter
  10   * image creation using mic
  11
  12 Resource
  13 --------
  14   * REPO: https://download.tizen.org/tools/
  15   * DOCS: [TODO]
  16   * CODE: https://review.tizen.org/gerrit/tools/tic-core
  17   * BUGS: https://bugs.tizen.org/jira
  18   * HELP: general@lists.tizen.org
  19
  20 License
  21 -------
  22 [TODO]
  23
  24 Installation
  25 ------------
  26
  27 Install the following python modules before installing tic-core
  28  * Install lxml (http://lxml.de/index.html)
  29  * Install flask (http://flask.pocoo.org/)
  30
  31 Clones the tic-core source from git
  32  * git clone ssh://review.tizen.org:29418/tools/tic-core
  33
  34 Install tic-core module
  35  * sudo python setup.py install
  36
  37 Usage
  38 -----
  39
  40 You can use 'tic-core --help' or 'mic <subcmd> --help' to get the help message.
  41 How to get help:
  42 * For global options and the command list:
  43   * $ tic-core -h | --help
  44 * For each sub-command:
  45   * $ tic-core <sub-command> --help
  46
  47 tic-core provides several subcommands, including:
  48 * tic-core start:
  49   * the tic-core daemon server on system. port 8082 is used default
  50   * $ tic-core start --port 8082
  51 * tic-core analyze:
  52   * analyze install-dependency of packages
  53   * $ tic-core analyze --repos {repo-url}
  54 * tic-core export:
  55   * export files (ks/recipes)
  56   * $ tic-core export --format ks --recipes {recipes} --outdir /var/tmp
  57   * $ tic-core export --format recipe --recipes {recipes} --outdir /var/tmp
  58 * tic-core createimage:
  59   * create an image for tizen
  60   * $ tic-core createimage --recipe {recipe} --output /var/tmp
  61
  62 Contacts
  63 --------
  64 When you found a bug, you can file this bug in our official bug tracker:
  65 https://bugs.tizen.org/jira