From 59a34a2809b8f7f41592a1727ea68f16e16d7178 Mon Sep 17 00:00:00 2001 From: Hosung Kim Date: Mon, 25 Mar 2024 14:06:57 +0900 Subject: [PATCH] doc: combine lwnode modules doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Hosung Kim hs852.kim@samsung.com --- docs/Build.md | 13 ------------- docs/lwnode-modules.md | 15 ++++++++++++++- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/Build.md b/docs/Build.md index 0cd4b7a7de..8c191fac4d 100644 --- a/docs/Build.md +++ b/docs/Build.md @@ -83,16 +83,3 @@ $ gbs -c .github/gbs.conf build -A arm7l --include-all --incremental --define 'l Options list: `lib_type` : shared(default)|static - -### 4.3. build lwnode module -We provide several modules. To build them, use the command below. - -```sh -$ gbs -c .github/gbs.conf build -A arm7l --packaging-dir modules/packages/packaging --include-all --incremental -``` - -You can find build result file in `out/modules/tizen`. - -Modules lists: -[device-api](modules/packages/device-api/README.md) -[gamain-loop](modules/packages/gamain-loop/README.md) diff --git a/docs/lwnode-modules.md b/docs/lwnode-modules.md index ea4832e8f8..f1de3958e2 100644 --- a/docs/lwnode-modules.md +++ b/docs/lwnode-modules.md @@ -1,8 +1,18 @@ # LWNode modules +## Build modules +LWNode supports special modules for Tizen. To build them, use the command below. + +```sh +$ gbs -c .github/gbs.conf build -A arm7l --packaging-dir modules/packages/packaging --include-all --incremental +``` + +You can find build result file in `/out/modules/tizen`. + + ## Install modules -LWNode supports special modules. In order to use these modules, need to install a `lwnode-modules-x.x.x-x.armv7l.rpm` on your device. +In order to use these modules, need to install a `lwnode-modules-x.x.x-x.armv7l.rpm` on your device. ```console rpm -Uvh --nodeps --force lwnode-modules-1.0.0-1.armv7l.rpm @@ -14,6 +24,9 @@ For example, const gmainLoop = require('gmain-loop'); ``` +To include a module in your app without installing the module globally, copy the built `.node` file from `/out/modules/tizen`. + + ## Supported modules * [gmain-loop](modules/packages/gmain-loop/README.md): change node event loop to gmain loop * [device-api](modules/packages/device-api/README.md): support tizen device-api