From: Romain Forlot Date: Sun, 28 May 2017 16:24:15 +0000 (+0200) Subject: Update README instructions. X-Git-Tag: Renesas_delivery_Q2~85 X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=commitdiff_plain;h=e639fc41adbd3dde2bd8a2be746c772171fa1b9d;p=apps%2Flow-level-can-service.git Update README instructions. Adding git submodules instructions before building. Change-Id: I8b1aa09e5ca69c0e2a7e8acbf6d80593a5fc0f22 Signed-off-by: Romain Forlot --- diff --git a/CAN-binder/README.md b/CAN-binder/README.md new file mode 100644 index 0000000..e514658 --- /dev/null +++ b/CAN-binder/README.md @@ -0,0 +1,46 @@ +Short instructions to build CAN-binder project +================================= + +Prerequisites +---------------- + +Here are the prerequisite to build the project: + +- CMake >= 3.3 +- g++ >= 4.9 +- AGL Application framework binder +- NodeJS >= 6, to build html5 demo UI. + +Build instructions +---------------------- + +You can use the helper script `build.mk` to build the project : + +```bash +# Cleaning existing build dir +./build.mk mrproper +# Only build the binding +./build.mk build +# Package the binding and the demo UI. Will need NodeJS >= v6 +./build.mk package +``` + +Or using the CMake way: + +```bash +# Get some help to build stuff +git submodule init +git submodule update +# And go to build it +mkdir build +cd build +cmake .. +# Only build +make +# Build and package tree filled +make populate +# Build and generate a Widget file +make widget +``` + +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. \ No newline at end of file diff --git a/README.md b/README.md index a608363..1629ffb 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Just use build.sh script: ./build.sh ``` -This will build both projects under build directory for each of them. +This will build both projects under build directory for each of them with default configuration. # Generate documentation