README

   1 GENIVI Node Startup Controller README
   2 =====================================
   3
   4 This is the official source repository of the GENIVI Node Startup
   5 Controller.
   6
   7 At present, all relevant documentation for this project is available
   8 in the GENIVI wiki on
   9
  10   https://collab.genivi.org/wiki/display/genivi/SysInfraEGLifecycleExecPrjctBootManager
  11
  12
  13 License
  14 -------
  15
  16 For licensing information, see the COPYING file distributed along with
  17 with this project.
  18
  19
  20 Build Dependencies
  21 ------------------
  22
  23 The following libraries need to be installed in order to be able to
  24 build the Node Startup Controller:
  25
  26   automotive-dlt >= 2.2.0
  27   gio-2.0 >= 2.30.0
  28   glib-2.0 >= 2.30.0
  29   gobject-2.0 >= 2.30.0
  30   libsystemd-daemon >= 183
  31
  32 In addition to this, and apart from the standard tools like autoreconf,
  33 automake and libtool, the following command-line utilities need to be
  34 available for building:
  35
  36   gdbus-codegen
  37   gtkdocize (and related GTK-Doc tools)
  38
  39
  40 Build Instructions
  41 ------------------
  42
  43 In order to build the Node Startup Controller, run the following:
  44
  45   gtkdocize &&
  46   autoreconf -ivf &&
  47   ./configure [options] &&
  48   make
  49
  50 The following configure options are available apart from the standard
  51 choices:
  52
  53   --enable-debug=<yes|no>:
  54
  55     Enables or disables debug builds. Enabling
  56     debug will cause more compiler warnings to
  57     be generated that are then treated as errors
  58     and make the build fail. This is useful for
  59     catching problems during development.
  60
  61     The default is "no".
  62
  63   --with-prioritised-luc-types=<comma-separated integers>:
  64
  65     Allows to define an ordered list of LUC types to be prioritised
  66     during start-up.
  67
  68     The default is an empty list.
  69
  70 For more information about all available configure options, run:
  71
  72   ./configure --help
  73
  74
  75 Install Instructions
  76 --------------------
  77
  78 To install the Node Startup Controller after having built it, run:
  79
  80   make install
  81
  82
  83 Testing Instructions
  84 --------------------
  85
  86 To run any test suites shipped with the Node Startup Controller, run:
  87
  88   make check
  89
  90 There may also be some post-install tests that can only be performed
  91 after installing the Node Startup Controller into the system. Those
  92 can be executed with:
  93
  94   make installcheck