README

   1 # Universal-Switch
   2
   3 ## About
   4 Use customizable switches to interact with your phone and selected items shown on the screen. You can set your personal interaction method using external accessories, tapping the screen, or using the front camera to detect the movement of your head, the opening of your mouth, and the blinking of your eyes.
   5
   6 Project contains special tool created for developers to help with basic actions as building, deploying and running tests.
   7 Tool is called 'project-tool'. Short manual can be printed by adding '-h' option.
   8
   9 ## Building
  10 Building process can be performed by executing:
  11
  12         % ./project-tool --build=[BUILT_TYPE]
  13
  14 Available options are:
  15 1. initial: it should be used when there is no GBS-ROOT directory or previously built project was not Universal-Switch
  16 2. fast: the best option when working with Universal-Switch
  17 3. no-test: builds project like 'fast' but does not create package with test scenarios
  18
  19 Default value depends on state of GBS-ROOT directory and equals 'initial' or 'fast'.
  20
  21 ## Installing
  22 Built packages can be easily installed on Tizen reference target by executing:
  23
  24         % ./project-tool --install=[PACKAGE]
  25
  26 This option base on default path for GBS-ROOT thus may not work properly unless project had been built with 'project-tool'.
  27 Tool uses 'sdb' thus it must be reached from PATH.
  28
  29 Available optons are:
  30 1. base: installs only application package
  31 2. tests: installs only tests package
  32 3. all: install both packages
  33
  34 Default value is 'all'.
  35
  36 ## Test running
  37 All tests are placed in universal-switch-tests rpm package thus they require Tizen reference target. They can be executed by:
  38
  39         % ./project-tool --run-tests
  40
  41 ## Extras
  42 Due to fact that part of test results are placed in systemd journal, it sometimes happens that there is no place in journal. Journal can be truncated to 1 KB by:
  43
  44         % ./project-tool --clean-journal