Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: combine lwnode modules doc #71

Merged
merged 1 commit into from
Mar 27, 2024
Merged

doc: combine lwnode modules doc #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions docs/Build.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading