Skip to content

Commit

Permalink
doc: combine lwnode modules doc
Browse files Browse the repository at this point in the history
Signed-off-by: Hosung Kim [email protected]
  • Loading branch information
hs0225 authored and daeyeon committed Mar 27, 2024
1 parent 2917b87 commit 4be57d6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
13 changes: 0 additions & 13 deletions docs/Build.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
15 changes: 14 additions & 1 deletion docs/lwnode-modules.md
Original file line number Diff line number Diff line change
@@ -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 `<lwnode_project_path>/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
Expand All @@ -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 `<module_name>.node` file from `<lwnode_project_path>/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

0 comments on commit 4be57d6

Please sign in to comment.