CAN-binder/README.md

   1 Short instructions to build CAN-binder project
   2 =================================
   3
   4 Prerequisites
   5 ----------------
   6
   7 Here are the prerequisite to build the project:
   8
   9 - CMake >= 3.3
  10 - g++ >= 4.9
  11 - AGL Application framework binder
  12 - NodeJS >= 6, to build html5 demo UI.
  13
  14 Build instructions
  15 ----------------------
  16
  17 You can use the helper script `build.mk` to build the project :
  18
  19 ```bash
  20 # Cleaning existing build dir
  21 ./build.mk mrproper
  22 # Only build the binding
  23 ./build.mk build
  24 # Package the binding and the demo UI. Will need NodeJS >= v6
  25 ./build.mk package
  26 ```
  27
  28 Or using the CMake way:
  29
  30 ```bash
  31 # Get some help to build stuff
  32 git submodule init
  33 git submodule update
  34 # And go to build it
  35 mkdir build
  36 cd build
  37 cmake ..
  38 # Only build
  39 make
  40 # Build and package tree filled
  41 make populate
  42 # Build and generate a Widget file
  43 make widget
  44 ```
  45
  46 The project is built in `build` directory, `package` directory will holds the _wgt_ file generated, this is used by Yocto buildsystem to include an AGL application cleanly in an AGL image. `conf.d/packaging` will contains widget configuration file.